GSAbstractDBDataStore: Geoserver REST API AbstractDBDataStore

GSAbstractDBDataStoreR Documentation

Geoserver REST API AbstractDBDataStore

Description

Geoserver REST API AbstractDBDataStore

Geoserver REST API AbstractDBDataStore

Format

R6Class object.

Value

Object of R6Class for modelling a GeoServer abstract DB dataStore

Super classes

geosapi::GSRESTResource -> geosapi::GSAbstractStore -> geosapi::GSAbstractDataStore -> GSAbstractDBDataStore

Methods

Public methods

Inherited methods

Method new()

initializes an abstract DB data store

Usage
GSAbstractDBDataStore$new(
  xml = NULL,
  type = NULL,
  dbType = NULL,
  name = NULL,
  description = "",
  enabled = TRUE
)
Arguments
xml

an object of class XMLInternalNode-class to create object from XML

type

the type of DB data store

dbType

DB type

name

coverage store name

description

coverage store description

enabled

whether the store should be enabled or not. Default is TRUE


Method setDatabaseType()

Set database type

Usage
GSAbstractDBDataStore$setDatabaseType(dbtype)
Arguments
dbtype

DB type


Method setNamespace()

Set namespace

Usage
GSAbstractDBDataStore$setNamespace(namespace)
Arguments
namespace

namespace


Method setHost()

Set host

Usage
GSAbstractDBDataStore$setHost(host)
Arguments
host

host


Method setPort()

Set port

Usage
GSAbstractDBDataStore$setPort(port)
Arguments
port

port


Method setDatabase()

Set database

Usage
GSAbstractDBDataStore$setDatabase(database)
Arguments
database

database


Method setSchema()

Set schema

Usage
GSAbstractDBDataStore$setSchema(schema)
Arguments
schema

schema


Method setUser()

Set user

Usage
GSAbstractDBDataStore$setUser(user)
Arguments
user

user


Method setPassword()

Set password

Usage
GSAbstractDBDataStore$setPassword(password)
Arguments
password

password


Method setJndiReferenceName()

Set JNDI reference name

Usage
GSAbstractDBDataStore$setJndiReferenceName(jndiReferenceName)
Arguments
jndiReferenceName

JNDI reference name


Method setExposePrimaryKeys()

Set expose primary keyws

Usage
GSAbstractDBDataStore$setExposePrimaryKeys(exposePrimaryKeys)
Arguments
exposePrimaryKeys

expose primary keys


Method setMinConnections()

Set min connections

Usage
GSAbstractDBDataStore$setMinConnections(minConnections = 1)
Arguments
minConnections

min connections. Default is 11


Method setMaxConnections()

Set max connections

Usage
GSAbstractDBDataStore$setMaxConnections(maxConnections = 10)
Arguments
maxConnections

max connections. Default is 10


Method setFetchSize()

Set fetch size

Usage
GSAbstractDBDataStore$setFetchSize(fetchSize = 1000)
Arguments
fetchSize

fetch size. Default is 1000


Method setConnectionTimeout()

Set connection timeout

Usage
GSAbstractDBDataStore$setConnectionTimeout(seconds = 20)
Arguments
seconds

timeout (in seconds). Default is 20


Method setValidateConnections()

Set validate connection

Usage
GSAbstractDBDataStore$setValidateConnections(validateConnections)
Arguments
validateConnections

Validate connections


Method setPrimaryKeyMetadataTable()

Set primary key metadata table

Usage
GSAbstractDBDataStore$setPrimaryKeyMetadataTable(primaryKeyMetadataTable)
Arguments
primaryKeyMetadataTable

primary key metadata table


Method setLooseBBox()

Set loose bbox

Usage
GSAbstractDBDataStore$setLooseBBox(looseBBox = TRUE)
Arguments
looseBBox

loose bbox. Default is TRUE


Method setPreparedStatements()

Set prepared statemnts

Usage
GSAbstractDBDataStore$setPreparedStatements(preparedStatements = FALSE)
Arguments
preparedStatements

prepared Statements. Default is FALSE


Method setMaxOpenPreparedStatements()

Set max open prepared statements

Usage
GSAbstractDBDataStore$setMaxOpenPreparedStatements(
  maxOpenPreparedStatements = 50
)
Arguments
maxOpenPreparedStatements

max open preepared statements. Default is 50


Method setEstimatedExtends()

Set estimatedExtends

Usage
GSAbstractDBDataStore$setEstimatedExtends(estimatedExtends = FALSE)
Arguments
estimatedExtends

estimated extends. Default is FALSE


Method setDefautConnectionParameters()

Set default connection parameters

Usage
GSAbstractDBDataStore$setDefautConnectionParameters()

Method clone()

The objects of this class are cloneable with this method.

Usage
GSAbstractDBDataStore$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Note

Internal abstract class used for setting DB stores

Author(s)

Emmanuel Blondel <emmanuel.blondel1@gmail.com>


geosapi documentation built on May 2, 2022, 5:05 p.m.