Database (Groovy Documentation)

geoscript.workspace.Database

class Database
extends Workspace

A Workspace that is a Database.

A Database subclass can add a SQL query as a Layer:

 Database db = new H2("acme", "target/h2")
 Layer statesLayer = h2.add(shp, 'states')
 String sql = """select st_centroid("the_geom") as "the_geom", "STATE_NAME" FROM "states""""
 Layer statesCentroidLayer = h2.createView("states_centroids", sql, new Field("the_geom", "Point", "EPSG:4326"))

Authors:: Jared Erickson

Constructor Summary

Constructors
Constructor and description
`Database (DataStore ds)` Create a new Database wrapping a GeoTools JDBCDataStore

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`createIndex(java.lang.String layerName, java.lang.String indexName, java.lang.String fieldName, boolean unique)` Create an index
	`void`	`createIndex(java.lang.String layerName, java.lang.String indexName, java.util.List<java.lang.String> fieldNames, boolean unique)` Create an index
	`Layer`	`createView(Map options, java.lang.String layerName, java.lang.String sql, Field geometryField)` Create a Layer from a SQL View
	`void`	`deleteIndex(java.lang.String layerName, java.lang.String indexName)` Delete an index
	`void`	`deleteView(java.lang.String name)` Delete a SQL View Layer
	`javax.sql.DataSource`	`getDataSource()` Get the javax.sql.DataSource
	`java.util.List`	`getIndexes(java.lang.String layerName)` Get a List of indexes for a layer or table by name
	`Sql`	`getSql()` Get a groovy.sql.Sql object that provides direct access to the underlying database
	`void`	`remove(java.lang.String layerName)` Remove the layer from the database

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Workspace`	`add, add, close, create, create, get, getAt, getFormat, getLayers, getNames, getParameters, getWorkspace, getWorkspace, getWorkspaceNames, getWorkspaceParameters, has, readFeatures, remove, remove, withWorkspace, withWorkspace, withWorkspace, wrap`

- Constructor Detail
  - Database(DataStore ds)
    
    Create a new Database wrapping a GeoTools JDBCDataStore
    Parameters:
    The - GeoTools DataStore
- Method Detail
  - void createIndex(java.lang.String layerName, java.lang.String indexName, java.lang.String fieldName, boolean unique)
    
    Create an index
    Parameters:
    layerName - The layer or table name
    indexName - The index name
    fieldName - The field name
    unique - Whether the index is unique or not
  - void createIndex(java.lang.String layerName, java.lang.String indexName, java.util.List<java.lang.String> fieldNames, boolean unique)
    
    Create an index
    Parameters:
    layerName - The layer or table name
    indexName - The index name
    fieldNames - A List of field names
    unique - Whether the index is unique or not
  - Layer createView(Map options, java.lang.String layerName, java.lang.String sql, Field geometryField)
    
    Create a Layer from a SQL View
    Parameters:
    options - The named parameters
    
    params = The query parameters
    
    primaryKeyFields = The list of primary key fields
    layerName - The layer name
    sql - The SQL
    geometryField - The geometry Field
    Returns:
    The new Layer
  - void deleteIndex(java.lang.String layerName, java.lang.String indexName)
    
    Delete an index
    Parameters:
    layerName - The layer or table name
    indexName - The index name
  - void deleteView(java.lang.String name)
    
    Delete a SQL View Layer
    Parameters:
    name - The name of the SQL View Layer
  - javax.sql.DataSource getDataSource()
    
    Get the javax.sql.DataSource
    Returns:
    The javax.sql.DataSource
  - java.util.List getIndexes(java.lang.String layerName)
    
    Get a List of indexes for a layer or table by name
    Parameters:
    layerName - The layer or table name
    Returns:
    A List of indexes
  - Sql getSql()
    
    Get a groovy.sql.Sql object that provides direct access to the underlying database
    Returns:
    A groovy.sql.Sql object
  - void remove(java.lang.String layerName)
    
    Remove the layer from the database
    Parameters:
    layerName - The layer name

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class Database

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

Database(DataStore ds)

Method Detail

void createIndex(java.lang.String layerName, java.lang.String indexName, java.lang.String fieldName, boolean unique)

void createIndex(java.lang.String layerName, java.lang.String indexName, java.util.List<java.lang.String> fieldNames, boolean unique)

Layer createView(Map options, java.lang.String layerName, java.lang.String sql, Field geometryField)

void deleteIndex(java.lang.String layerName, java.lang.String indexName)

void deleteView(java.lang.String name)

javax.sql.DataSource getDataSource()

java.util.List getIndexes(java.lang.String layerName)

Sql getSql()

void remove(java.lang.String layerName)