AddPGSQLLayer()
Summary
Add layer to map after exporting it to PGSQL spatial database.
Syntax
AddPGSQLLayer(string map_name, string name, string file_name, char table_name, string schema_name, array opts)
| Argument |
Type |
Contents |
| map_name |
string |
Name of map |
| name |
string |
Name of layer being exported |
| file_name |
string |
Name of server + database |
| table_name |
string |
Name of table to which layer is being exported |
| schema_name |
string |
Name of schema to which layer is being exported |
| options |
options array |
Options array |
| Option |
Type |
Contents |
| Fields |
array |
Layer fields |
| Indexed Fields |
array |
indexed layer fields |
| [ID Field] |
string |
Name of layer field used as id |
| [Layer Name] |
string |
Name of layer being exported |
| [Add To Map] |
integer |
1 if user wants layer added to map after export, 0 if not |
| Database |
string |
Name of database to which layer is being exported |
| Owner |
string |
Name of schema to which layer is being exported |
| SRID |
string |
Spatial reference identifier for layer geometry |
| Table |
string |
Name of table to which layer is being exported |
| LogFile |
string |
Path to log file |
| Type |
string |
Type of layer, e.g. "Line" |
| [Geometry Field] |
string |
Name of field containing geometric data |
Example
opts = {
Fields:["Field1","Field2"},
Indexed Fields:["Indexed Field1],
ID Field: "ID",
Layer Name: "My layer",
Add to Map: 1,
Database: "spatial_db1",
Owner: "public",
SRID: 4326,
Table: "table_1",
LogFile: "path\to\log.file",
Type: "Line",
Geometry Field: "Location"
}
Layer_name = AddPGSQLLayerToWOrkspace("USA2014", "My Streets", "localhost|spatial_db1", "table_1", "public", opts)
Error Codes
| Error Type |
Meaning |
| Error |
Invalid service name, table name or schema name; or failed to log user in with provided credentials; or failed to extract option from options array; or failed to add external layer to map |
| Not Found |
Map view is not found based on provided map name |
See Also
| Function |
Summary |
| AddPGSQLLayer() |
Add layer to map after exporting it to PGSQL spatial database |
| AddPGSQLLayerToWorkspace() |
Add layer to current workspace after exporting it to PGSQL spatial database |
| ExportPGSQL() |
Export map data to PGSQL spatial database |
| PGSQLClose() |
Close the connection with PostgreSQL , if it exists |
| PGSQLConnect() |
Establish a connection with PostgreSQL , if it exists |
| PGSQLExportFromQuery() |
Run an SQL query on the open PGSQL database connection and export results to a file |
| PGSQLGetDatabases() |
Retrieve a list of PGSQL databases from the connected database server |
| PSGQLGetSchemas |
Retrieve a list of schemas from a PGSQL database |
| PGSQLGetSpatialDatabases() |
Retrieve a list of PGSQL spatial databases from the connected database server |
| PGSQLGetTables() |
Retrieve a list of tables from a PGSQL database |
| PGSQLGetUniqueFields() |
Returns all unique fields from the PGSQL database table, as defined in the table constraints |
| PGSQLRunQuery() |
Run an SQL query on the open PGSQL database connection |
| PGSQLSetDatabase() |
Set database as the current selection in the "Open PostgreSQL Table" dialog box |
| PGSQLSetSchema() |
Set the name of the database schema to be displayed to the user in the "Open PostgreSQL Table" dialog box |
| PGSQLSetTable() |
Set the name of the table to be displayed to the user in the "Open PostgreSQL Table" dialog box |