Main SpatiaLite header file. More...

#include <spatialite/gaiageo.h>

Include dependency graph for spatialite.h:

Functions
SPATIALITE_DECLARE const char *	spatialite_version (void)
	Return the current library version.
SPATIALITE_DECLARE void	spatialite_init (int verbose)
	Initializes the library.
SPATIALITE_DECLARE void	spatialite_init_geos (void)
	Initializes the GEOS library.
SPATIALITE_DECLARE void	spatialite_cleanup (void)
	Cleanup spatialite.
SPATIALITE_DECLARE int	dump_shapefile (sqlite3 sqlite, char table, char column, char shp_path, char charset, char geom_type, int verbose, int rows, char err_msg)
	Dumps a full geometry-table into an external Shapefile.
SPATIALITE_DECLARE int	load_shapefile (sqlite3 sqlite, char shp_path, char table, char charset, int srid, char column, int coerce2d, int compressed, int verbose, int spatial_index, int rows, char *err_msg)
	Loads an external Shapefile into a newly created table.
SPATIALITE_DECLARE int	load_shapefile_ex (sqlite3 sqlite, char shp_path, char table, char charset, int srid, char geo_column, char gtype, char pk_column, int coerce2d, int compressed, int verbose, int spatial_index, int rows, char *err_msg)
	Loads an external Shapefile into a newly created table.
SPATIALITE_DECLARE int	load_dbf (sqlite3 sqlite, char dbf_path, char table, char charset, int verbose, int rows, char err_msg)
	Loads an external DBF file into a newly created table.
SPATIALITE_DECLARE int	load_dbf_ex (sqlite3 sqlite, char dbf_path, char table, char pk_column, char charset, int verbose, int rows, char *err_msg)
	Loads an external DBF file into a newly created table.
SPATIALITE_DECLARE int	dump_dbf (sqlite3 sqlite, char table, char dbf_path, char charset, char *err_msg)
	Dumps a full table into an external DBF file.
SPATIALITE_DECLARE int	load_XL (sqlite3 sqlite, const char path, const char table, unsigned int worksheetIndex, int first_titles, unsigned int rows, char *err_msg)
	Loads an external spreadsheet (.xls) file into a newly created table.
SPATIALITE_DECLARE double	math_round (double value)
	A portable replacement for C99 round()
SPATIALITE_DECLARE sqlite3_int64	math_llabs (sqlite3_int64 value)
	A portable replacement for C99 llabs()
SPATIALITE_DECLARE int	spatial_ref_sys_init (sqlite3 *sqlite, int verbose)
	Inserts the inlined EPSG dataset into the "spatial_ref_sys" table.
SPATIALITE_DECLARE int	spatial_ref_sys_init2 (sqlite3 *sqlite, int mode, int verbose)
	Inserts the inlined EPSG dataset into the "spatial_ref_sys" table.
SPATIALITE_DECLARE int	insert_epsg_srid (sqlite3 *sqlite, int srid)
	Inserts some inlined EPSG definition into the "spatial_ref_sys" table.
SPATIALITE_DECLARE int	is_kml_constant (sqlite3 sqlite, char table, char *column)
	Checks if a column is actually defined into the given table.
SPATIALITE_DECLARE int	dump_kml (sqlite3 sqlite, char table, char geom_col, char kml_path, char name_col, char desc_col, int precision)
	Dumps a full geometry-table into an external KML file.
SPATIALITE_DECLARE void	check_duplicated_rows (sqlite3 sqlite, char table, int *dupl_count)
	Checks for duplicated rows into the same table.
SPATIALITE_DECLARE void	remove_duplicated_rows (sqlite3 sqlite, char table)
	Remove duplicated rows from a table.
SPATIALITE_DECLARE void	elementary_geometries (sqlite3 sqlite, char inTable, char geometry, char outTable, char pKey, char multiId)
	Creates a derived table surely containing elementary Geometries.
SPATIALITE_DECLARE int	dump_geojson (sqlite3 sqlite, char table, char geom_col, char outfile_path, int precision, int option)
	Dumps a full geometry-table into an external GeoJSON file.
SPATIALITE_DECLARE int	update_layer_statistics (sqlite3 sqlite, const char table, const char *column)
	Updates the LAYER_STATICS metadata table.
SPATIALITE_DECLARE gaiaVectorLayersListPtr	gaiaGetVectorLayersList (sqlite3 handle, const char table, const char *geometry, int mode)
	Queries the Metadata tables supporting Vector Layers.
SPATIALITE_DECLARE void	gaiaFreeVectorLayersList (gaiaVectorLayersListPtr ptr)
	Destroys a VectorLayersList object.
SPATIALITE_DECLARE int	gaiaDropTable (sqlite3 sqlite, const char table)
	Drops a layer-table, removing any related dependency.

Detailed Description

Main SpatiaLite header file.

Function Documentation

SPATIALITE_DECLARE void check_duplicated_rows	(	sqlite3 *	sqlite,
		char *	table,
		int *	dupl_count
	)

Checks for duplicated rows into the same table.

Parameters:

sqlite	handle to current DB connection
table	name of the table to be checked
dupl_count	on completion will contain the number of duplicated rows found

See also:: remove_duplicated_rows

Note:: two (or more) rows are assumed to be duplicated if any column

value (excluding any Primary Key column) is exacly the same

SPATIALITE_DECLARE int dump_dbf	(	sqlite3 *	sqlite,
		char *	table,
		char *	dbf_path,
		char *	charset,
		char *	err_msg
	)

Dumps a full table into an external DBF file.

Parameters:

sqlite	handle to current DB connection
table	the name of the table to be exported
dbf_path	pathname of the DBF to be exported
charset	a valid GNU ICONV charset to be used for DBF text strings
err_msg	on completion will contain an error message (if any)

Returns:: 0 on failure, any other value on success

SPATIALITE_DECLARE int dump_geojson	(	sqlite3 *	sqlite,
		char *	table,
		char *	geom_col,
		char *	outfile_path,
		int	precision,
		int	option
	)

Dumps a full geometry-table into an external GeoJSON file.

Parameters:

sqlite	handle to current DB connection
table	the name of the table to be exported
geom_col	the name of the geometry column
outfile_path	pathname for the GeoJSON file to be written to
precision	number of decimal digits for coordinates
option	the format to use for output

Note:

valid values for option are:

0 no option
1 GeoJSON MBR
2 GeoJSON Short CRS (e.g EPSG:4326)
3 MBR + Short CRS
4 GeoJSON Long CRS (e.g urn:ogc:def:crs:EPSG::4326)
5 MBR + Long CRS

Returns:: 0 on failure, any other value on success

SPATIALITE_DECLARE int dump_kml	(	sqlite3 *	sqlite,
		char *	table,
		char *	geom_col,
		char *	kml_path,
		char *	name_col,
		char *	desc_col,
		int	precision
	)

Dumps a full geometry-table into an external KML file.

Parameters:

sqlite	handle to current DB connection
table	the name of the table to be exported
geom_col	the name of the geometry column
kml_path	pathname of the KML file to be exported
name_col	column to be used for KML "name" (may be null)
desc_col	column to be used for KML "description" (may be null)
precision	number of decimal digits for coordinates

Returns:: 0 on failure, any other value on success

SPATIALITE_DECLARE int dump_shapefile	(	sqlite3 *	sqlite,
		char *	table,
		char *	column,
		char *	shp_path,
		char *	charset,
		char *	geom_type,
		int	verbose,
		int *	rows,
		char *	err_msg
	)

Dumps a full geometry-table into an external Shapefile.

Parameters:

sqlite	handle to current DB connection
table	the name of the table to be exported
column	the name of the geometry column
shp_path	pathname of the Shapefile to be exported (no suffix)
charset	a valid GNU ICONV charset to be used for DBF text strings
geom_type	"POINT", "LINESTRING", "POLYGON", "MULTIPOLYGON" or NULL
verbose	if TRUE a short report is shown on stderr
rows	on completion will contain the total number of actually exported rows
err_msg	on completion will contain an error message (if any)

Returns:: 0 on failure, any other value on success

SPATIALITE_DECLARE void elementary_geometries	(	sqlite3 *	sqlite,
		char *	inTable,
		char *	geometry,
		char *	outTable,
		char *	pKey,
		char *	multiId
	)

Creates a derived table surely containing elementary Geometries.

Parameters:

sqlite	handle to current DB connection
inTable	name of the input table
geometry	name of the Geometry column
outTable	name of the output table to be created
pKey	name of the Primary Key column in the output table
multiId	name of the column identifying origins in the output table

Note:: if the input table contains some kind of complex Geometry (MULTIPOINT, MULTILINESTRING, MULTIPOLYGON or GEOMETRYCOLLECTION), then many rows are inserted into the output table: each single row will contain the same attributes and an elementaty Geometry. All the rows created by expanding the same input row will expose the same value in the "multiId" column.

SPATIALITE_DECLARE int gaiaDropTable	(	sqlite3 *	sqlite,
		const char *	table
	)

Drops a layer-table, removing any related dependency.

Parameters:

sqlite	handle to current DB connection
table	name of the table to be removed

Note:: this function will drop a SpatialTable, SpatialView or VirtualShape being properly registered within the Metadata tables.
an eventual Spatial Index will be dropped as well, and any row referring the selected table will be removed from the Metadata tables.

Returns:: 0 on failure, any other value on success

SPATIALITE_DECLARE void gaiaFreeVectorLayersList ( gaiaVectorLayersListPtr ptr )

Destroys a VectorLayersList object.

Parameters:

ptr	pointer to the VectorLayersList object to be destroyed

See also:: gaiaGetVectorLayersList

Examples:: demo5.c.

SPATIALITE_DECLARE gaiaVectorLayersListPtr gaiaGetVectorLayersList	(	sqlite3 *	handle,
		const char *	table,
		const char *	geometry,
		int	mode
	)

Queries the Metadata tables supporting Vector Layers.

Parameters:

handle	SQLite handle to current DB connection.
table	VectorLayer Table (or View, or VirtualShape).
geometry	Geometry Column name.
mode	one of GAIA_VECTORS_LIST_LOOSE or GAIA_VECTORS_LIST_STRICT.

Returns:: the pointer to the newly created VectorLayersList object: NULL on failure

See also:: gaiaFreeVectorLayersList

Note:: you are responsible to destroy (before or after) any allocated VectorLayersList returned by gaiaGetVectorLayersList().
If the table arg is NULL all VectorLayers defined within the DB will be reported; otherwise only a single Layer will be reported (if existing).
By defining the geometry arg (not NULL) you can further restrict the returned report.
When the mode arg is set to GAIA_VECTORS_LIST_FAST (default) then the returned infos will be simply retrieved from the staticized statistic tables (faster, but could be inaccurate).
If the mode arg is set to GAIA_VECTORS_LIST_PRECISE a preliminary attempt to update the statistic tables will be always performed (probably slower, but surely accurate).

Examples:: demo5.c.

SPATIALITE_DECLARE int insert_epsg_srid	(	sqlite3 *	sqlite,
		int	srid
	)

Inserts some inlined EPSG definition into the "spatial_ref_sys" table.

Parameters:

sqlite	handle to current DB connection
srid	the SRID value uniquely identifying the required EPSG definition

Returns:: 0 on failure, any other value on success

SPATIALITE_DECLARE int is_kml_constant	(	sqlite3 *	sqlite,
		char *	table,
		char *	column
	)

Checks if a column is actually defined into the given table.

Parameters:

sqlite	handle to current DB connection
table	the table to be checked
column	the column to be checked

Returns:: 0 on success, any other value on success

Note:: internally used to detect if some KML attribute defaults to a constant value

SPATIALITE_DECLARE int load_dbf	(	sqlite3 *	sqlite,
		char *	dbf_path,
		char *	table,
		char *	charset,
		int	verbose,
		int *	rows,
		char *	err_msg
	)

Loads an external DBF file into a newly created table.

Parameters:

sqlite	handle to current DB connection
dbf_path	pathname of the DBF file to be imported
table	the name of the table to be created
charset	a valid GNU ICONV charset to be used for DBF text strings
verbose	if TRUE a short report is shown on stderr
rows	on completion will contain the total number of actually exported rows
err_msg	on completion will contain an error message (if any)

See also:: load_dbf_ex

Note:: this function simply calls load_dbf_ex by passing an implicit pk_column=NULL argument

Returns:: 0 on failure, any other value on success

SPATIALITE_DECLARE int load_dbf_ex	(	sqlite3 *	sqlite,
		char *	dbf_path,
		char *	table,
		char *	pk_column,
		char *	charset,
		int	verbose,
		int *	rows,
		char *	err_msg
	)

Loads an external DBF file into a newly created table.

Parameters:

sqlite	handle to current DB connection
dbf_path	pathname of the DBF file to be imported
table	the name of the table to be created
pk_column	name of the Primary Key column; if NULL or mismatching then "PK_UID" will be assumed by default.
charset	a valid GNU ICONV charset to be used for DBF text strings
verbose	if TRUE a short report is shown on stderr
rows	on completion will contain the total number of actually exported rows
err_msg	on completion will contain an error message (if any)

See also:: load_shapefile

Returns:: 0 on failure, any other value on success

SPATIALITE_DECLARE int load_shapefile	(	sqlite3 *	sqlite,
		char *	shp_path,
		char *	table,
		char *	charset,
		int	srid,
		char *	column,
		int	coerce2d,
		int	compressed,
		int	verbose,
		int	spatial_index,
		int *	rows,
		char *	err_msg
	)

Loads an external Shapefile into a newly created table.

Parameters:

sqlite	handle to current DB connection
shp_path	pathname of the Shapefile to be imported (no suffix)
table	the name of the table to be created
charset	a valid GNU ICONV charset to be used for DBF text strings
srid	the SRID to be set for Geometries
column	the name of the geometry column
coerce2d	if TRUE any Geometry will be casted to 2D [XY]
compressed	if TRUE compressed Geometries will be created
verbose	if TRUE a short report is shown on stderr
spatial_index	if TRUE an R*Tree Spatial Index will be created
rows	on completion will contain the total number of actually exported rows
err_msg	on completion will contain an error message (if any)

Returns:: 0 on failure, any other value on success

See also:: load_shapefile_ex

Note:: this function simply calls load_shapefile_ex by passing implicit gype="AUTO" and pk_column=NULL arguments

SPATIALITE_DECLARE int load_shapefile_ex	(	sqlite3 *	sqlite,
		char *	shp_path,
		char *	table,
		char *	charset,
		int	srid,
		char *	geo_column,
		char *	gtype,
		char *	pk_column,
		int	coerce2d,
		int	compressed,
		int	verbose,
		int	spatial_index,
		int *	rows,
		char *	err_msg
	)

Loads an external Shapefile into a newly created table.

Parameters:

sqlite	handle to current DB connection
shp_path	pathname of the Shapefile to be imported (no suffix)
table	the name of the table to be created
charset	a valid GNU ICONV charset to be used for DBF text strings
srid	the SRID to be set for Geometries
geo_column	the name of the geometry column
gtype	expected to be one of: "LINESTRING", "LINESTRINGZ", "LINESTRINGM", "LINESTRINGZM", "MULTILINESTRING", "MULTILINESTRINGZ", "MULTILINESTRINGM", "MULTILINESTRINGZM", "POLYGON", "POLYGONZ", "POLYGONM", "POLYGONZM", "MULTIPOLYGON", "MULTIPOLYGONZ", "MULTIPOLYGONM", "MULTIPOLYGONZM" or "AUTO".
pk_column	name of the Primary Key column; if NULL or mismatching then "PK_UID" will be assumed by default.
coerce2d	if TRUE any Geometry will be casted to 2D [XY]
compressed	if TRUE compressed Geometries will be created
verbose	if TRUE a short report is shown on stderr
spatial_index	if TRUE an R*Tree Spatial Index will be created
rows	on completion will contain the total number of actually exported rows
err_msg	on completion will contain an error message (if any)

Returns:: 0 on failure, any other value on success

See also:: load_shapefile

Note:: the Shapefile format doesn't supports any distinction between LINESTRINGs and MULTILINESTRINGs, or between POLYGONs and MULTIPOLYGONs; as does not allows to clearly distinguish if the M-measure is required.
So a first preliminary scan of the Shapefile is required in order to correctly identify the actual payload (gtype = "AUTO", default case).
By explicitly specifying some expected geometry type this first scan will be skipped at all thus introducing a noticeable performance gain.
Anyway, declaring a mismatching geometry type will surely cause a failure.

SPATIALITE_DECLARE int load_XL	(	sqlite3 *	sqlite,
		const char *	path,
		const char *	table,
		unsigned int	worksheetIndex,
		int	first_titles,
		unsigned int *	rows,
		char *	err_msg
	)

Loads an external spreadsheet (.xls) file into a newly created table.

Parameters:

sqlite	handle to current DB connection
path	pathname of the spreadsheet file to be imported
table	the name of the table to be created
worksheetIndex	the index identifying the worksheet to be imported
first_titles	if TRUE the first line is assumed to contain column names
rows	on completion will contain the total number of actually exported rows
err_msg	on completion will contain an error message (if any)

Returns:: 0 on failure, any other value on success

SPATIALITE_DECLARE sqlite3_int64 math_llabs ( sqlite3_int64 value )

A portable replacement for C99 llabs()

Parameters:

value a 64 bit integer value

Returns:: the corresponding absolute value

SPATIALITE_DECLARE double math_round ( double value )

A portable replacement for C99 round()

Parameters:

value a double value

Returns:: the nearest integeral value

SPATIALITE_DECLARE void remove_duplicated_rows	(	sqlite3 *	sqlite,
		char *	table
	)

Remove duplicated rows from a table.

Parameters:

sqlite	handle to current DB connection
table	name of the table to be cleaned

See also:: check_duplicated_rows

Note:: when two (or more) duplicated rows exist, only the first occurence will be preserved, then deleting any further occurrence.

SPATIALITE_DECLARE int spatial_ref_sys_init	(	sqlite3 *	sqlite,
		int	verbose
	)

Inserts the inlined EPSG dataset into the "spatial_ref_sys" table.

Parameters:

sqlite	handle to current DB connection
verbose	if TRUE a short report is shown on stderr

Returns:: 0 on failure, any other value on success

See also:: spatial_ref_sys_init2

Note:: this function is internally invoked by the SQL function InitSpatialMetadata(), and is not usually intended for direct use. This functions is now deprecated, and will simply call spatial_ref_sys_init2(sqlite, GAIA_EPSG_ANY, verbose).

SPATIALITE_DECLARE int spatial_ref_sys_init2	(	sqlite3 *	sqlite,
		int	mode,
		int	verbose
	)

Inserts the inlined EPSG dataset into the "spatial_ref_sys" table.

Parameters:

sqlite	handle to current DB connection
mode	can be one of GAIA_EPSG_ANY, GAIA_EPSG_NONE or GAIA_EPSG_WGS84_ONLY
verbose	if TRUE a short report is shown on stderr

Returns:: 0 on failure, any other value on success

Note:: this function is internally invoked by the SQL function InitSpatialMetadata(), and is not usually intended for direct use.

SPATIALITE_DECLARE void spatialite_cleanup ( void )

Cleanup spatialite.

This function performs general cleanup, essentially undoing the effect of spatialite_init().

See also:: spatialite_init

Examples:: demo1.c, demo2.c, demo3.c, demo4.c, and demo5.c.

SPATIALITE_DECLARE void spatialite_init ( int verbose )

Initializes the library.

Parameters:

verbose if TRUE a short start-up message is shown on stderr

Note:: You absolutely must invoke this function before attempting to perform any other SpatiaLite's call.

Examples:: demo1.c, demo2.c, demo3.c, demo4.c, and demo5.c.

SPATIALITE_DECLARE void spatialite_init_geos ( void )

Initializes the GEOS library.

Note:: You are never supposed to invoke this function (internally handled).

SPATIALITE_DECLARE int update_layer_statistics	(	sqlite3 *	sqlite,
		const char *	table,
		const char *	column
	)

Updates the LAYER_STATICS metadata table.

Parameters:

sqlite	handle to current DB connection
table	name of the table to be processed
column	name of the geometry to be processed

Note:

this function will explore the given table/geometry determining the number of rows and the full layer extent; a corresponding table/geometry entry is expected to be already declared in the GEOMETRY_COLUMNS table. These informations will be permanently stored into the LAYER_STATISTICS table; if such table does not yet exists will be implicitly created.

if table is NULL, any entry found within GEOMETRY_COLUMNS will be processed.
if table is not NULL and column is NULL, any geometry belonging to the given table will be processed.
if both table and column are not NULL, then only the given entry will be processed.

Returns:: 0 on failure, the total count of processed entries on success

Functions

Detailed Description

Function Documentation