SQLDatabaseProvider (SAP Cloud Platform - Server OData API for Mobile Services)

java.lang.Object
- com.sap.cloud.server.odata.SQLDatabaseProvider

All Implemented Interfaces:

DataServiceProvider
```
public class SQLDatabaseProvider
extends java.lang.Object
implements DataServiceProvider
```
An implementation of DataServiceProvider using a SQL database. Tested (in Java runtime) with H2, PostgreSQL, SAP HANA, SAP ASE, and SAP SQL Anywhere.

Constructor Summary

Constructors
Constructor and Description
`SQLDatabaseProvider(java.lang.String serviceName)` See SQLDatabaseProvider(String, String).
`SQLDatabaseProvider(java.lang.String serviceName, java.lang.String databaseURL)` Constructs a SQL database provider.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyChanges(ChangeSet changes)` See applyChanges(ChangeSet, HttpHeaders, RequestOptions).
`void`	`applyChanges(ChangeSet changes, HttpHeaders headers)` See applyChanges(ChangeSet, HttpHeaders, RequestOptions).
`void`	`applyChanges(ChangeSet changes, HttpHeaders headers, RequestOptions options)` Apply the changes from a change set to the target system.
`void`	`beginTransaction()` Begin a new transaction, or begin a nested transaction if a transaction is already active for this provider in the current thread.
`void`	`bindEntities(EntityValue entity)` See bindEntities(EntityValue, Property, boolean, boolean).
`void`	`bindEntities(EntityValue entity, Property bindingProperty)` See bindEntities(EntityValue, Property, boolean, boolean).
`void`	`bindEntities(EntityValue entity, Property bindingProperty, boolean afterCreate)` See bindEntities(EntityValue, Property, boolean, boolean).
`void`	`bindEntities(EntityValue entity, Property bindingProperty, boolean afterCreate, boolean afterUpdate)` This function may be used in the implementation of entity binding calls, e.g.
`void`	`bindEntitiesAfterCreate(EntityValue entity)` See bindEntitiesAfterCreate(EntityValue, Property).
`void`	`bindEntitiesAfterCreate(EntityValue entity, Property bindingProperty)` This function may be used in the implementation of entity binding calls after the main create action of `SQLDatabaseProvider.createEntity`.
`void`	`bindEntitiesAfterUpdate(EntityValue entity)` See bindEntitiesAfterUpdate(EntityValue, Property).
`void`	`bindEntitiesAfterUpdate(EntityValue entity, Property bindingProperty)` This function may be used in the implementation of entity binding calls after the main update action of `SQLDatabaseProvider.updateEntity`.
`void`	`closeAllConnections()` Close connections to this database from all threads.
`void`	`closeConnection()` If the current thread is connected to this database, then disconnect it.
`void`	`commit()` Commit the current transaction.
`void`	`createChildren(EntityValue entity)` See createChildren(EntityValue, Property).
`void`	`createChildren(EntityValue entity, Property childProperty)` This function may be used in the implementation of "deep insert" calls, e.g.
`void`	`createClientExpiry(EntityValue registration)` Arrange for client expiry after a client registration has been created.
`void`	`createEntity(EntityValue entity)` See createEntity(EntityValue, HttpHeaders, RequestOptions).
`void`	`createEntity(EntityValue entity, HttpHeaders headers)` See createEntity(EntityValue, HttpHeaders, RequestOptions).
`void`	`createEntity(EntityValue entity, HttpHeaders headers, RequestOptions options)` Create an entity in the target system.
`java.lang.RuntimeException`	`createEntityReturningError(EntityValue entity)` See createEntityReturningError(EntityValue, HttpHeaders, RequestOptions).
`java.lang.RuntimeException`	`createEntityReturningError(EntityValue entity, HttpHeaders headers)` See createEntityReturningError(EntityValue, HttpHeaders, RequestOptions).
`java.lang.RuntimeException`	`createEntityReturningError(EntityValue entity, HttpHeaders headers, RequestOptions options)` Call `SQLDatabaseProvider.createEntity` but catch any excepion it throws (non-logged) and return it.
`void`	`createLink(EntityValue from, Property property, EntityValue to)` See createLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).
`void`	`createLink(EntityValue from, Property property, EntityValue to, HttpHeaders headers)` See createLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).
`void`	`createLink(EntityValue from, Property property, EntityValue to, HttpHeaders headers, RequestOptions options)` Create a link from a source entity to a target entity.
`void`	`createLinkUsingForeignKeys(EntityValue source, Property sourceProperty, EntityValue target)` Default implementation of 'createLink' using foreign keys from referential constraints in service metadata.
`void`	`createMedia(EntityValue entity, StreamBase content)` See createMedia(EntityValue, StreamBase, HttpHeaders, RequestOptions).
`void`	`createMedia(EntityValue entity, StreamBase content, HttpHeaders headers)` See createMedia(EntityValue, StreamBase, HttpHeaders, RequestOptions).
`void`	`createMedia(EntityValue entity, StreamBase content, HttpHeaders headers, RequestOptions options)` Create a media entity with the specified content in the target system.
`void`	`createParents(EntityValue entity)` See createParents(EntityValue, Property).
`void`	`createParents(EntityValue entity, Property parentProperty)` This function may be used in the implementation of "deep insert" calls, e.g.
`void`	`createSchema()` Create (if non-existent) the database schema artifacts (e.g.
`void`	`createSchemaForTenant()` Create (if non-existent) the database artifacts (e.g.
`void`	`createSchemaWithRetryLoop()` Create (if non-existent) the database schema artifacts (e.g.
`GlobalDateTime`	`currentLDT()` Return the current local date/time according to the database server.
`GlobalDateTime`	`currentUTC()` Return the current global time (UTC) according to the database server.
`void`	`deleteByQuery(DataQuery query)` See deleteByQuery(DataQuery, HttpHeaders, RequestOptions).
`void`	`deleteByQuery(DataQuery query, HttpHeaders headers)` See deleteByQuery(DataQuery, HttpHeaders, RequestOptions).
`void`	`deleteByQuery(DataQuery query, HttpHeaders headers, RequestOptions options)` Execute query to delete data from the target system.
`void`	`deleteChildren(EntityValue entity)` See deleteChildren(EntityValue, Property).
`void`	`deleteChildren(EntityValue entity, Property childProperty)` This function may be used in the implementation of "on delete" actions, e.g.
`void`	`deleteEntity(EntityValue entity)` See deleteEntity(EntityValue, HttpHeaders, RequestOptions).
`void`	`deleteEntity(EntityValue entity, HttpHeaders headers)` See deleteEntity(EntityValue, HttpHeaders, RequestOptions).
`void`	`deleteEntity(EntityValue entity, HttpHeaders headers, RequestOptions options)` Delete an entity from the target system.
`java.lang.RuntimeException`	`deleteEntityReturningError(EntityValue entity)` See deleteEntityReturningError(EntityValue, HttpHeaders, RequestOptions).
`java.lang.RuntimeException`	`deleteEntityReturningError(EntityValue entity, HttpHeaders headers)` See deleteEntityReturningError(EntityValue, HttpHeaders, RequestOptions).
`java.lang.RuntimeException`	`deleteEntityReturningError(EntityValue entity, HttpHeaders headers, RequestOptions options)` Call `SQLDatabaseProvider.deleteEntity` but catch any excepion it throws (non-logged) and return it.
`void`	`deleteLink(EntityValue from, Property property, EntityValue to)` See deleteLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).
`void`	`deleteLink(EntityValue from, Property property, EntityValue to, HttpHeaders headers)` See deleteLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).
`void`	`deleteLink(EntityValue from, Property property, EntityValue to, HttpHeaders headers, RequestOptions options)` Delete a link from a source entity to a target entity.
`void`	`deleteLinkUsingForeignKeys(EntityValue source, Property sourceProperty, EntityValue target)` Default implementation of 'deleteLink' using foreign keys from referential constraints in service metadata.
`void`	`deleteSchema()` Delete (if existing) the database schema artifacts (e.g.
`void`	`deleteSchemaForTenant()` Delete (if existing) the database artifacts (e.g.
`void`	`deleteStream(EntityValue entity, StreamLink link)` See deleteStream(EntityValue, StreamLink, HttpHeaders, RequestOptions).
`void`	`deleteStream(EntityValue entity, StreamLink link, HttpHeaders headers)` See deleteStream(EntityValue, StreamLink, HttpHeaders, RequestOptions).
`void`	`deleteStream(EntityValue entity, StreamLink link, HttpHeaders headers, RequestOptions options)` Delete the content of a stream property from the target system.
`ByteStream`	`downloadMedia(EntityValue entity)` See downloadMedia(EntityValue, HttpHeaders, RequestOptions).
`ByteStream`	`downloadMedia(EntityValue entity, HttpHeaders headers)` See downloadMedia(EntityValue, HttpHeaders, RequestOptions).
`ByteStream`	`downloadMedia(EntityValue entity, HttpHeaders headers, RequestOptions options)` Obtain a stream for downloading the content of a media entity from the target system.
`ByteStream`	`downloadStream(EntityValue entity, StreamLink link)` See downloadStream(EntityValue, StreamLink, HttpHeaders, RequestOptions).
`ByteStream`	`downloadStream(EntityValue entity, StreamLink link, HttpHeaders headers)` See downloadStream(EntityValue, StreamLink, HttpHeaders, RequestOptions).
`ByteStream`	`downloadStream(EntityValue entity, StreamLink link, HttpHeaders headers, RequestOptions options)` Obtain a stream for downloading the content of a stream property from the target system.
`DataContext`	`entityContext(EntitySet entitySet, StructureType derivedType, int format, int version)` Return a data context for a specified entity set, data format and data version.
`void`	`executeBatch()` If the current thread's connection has batched statements, execute them now.
`DataValue`	`executeMethod(DataMethod method, ParameterList parameters)` See executeMethod(DataMethod, ParameterList, HttpHeaders, RequestOptions).
`DataValue`	`executeMethod(DataMethod method, ParameterList parameters, HttpHeaders headers)` See executeMethod(DataMethod, ParameterList, HttpHeaders, RequestOptions).
`DataValue`	`executeMethod(DataMethod method, ParameterList parameters, HttpHeaders headers, RequestOptions options)` Execute a data method (action or function) in the target system.
`QueryResult`	`executeQuery(DataQuery query)` See executeQuery(DataQuery, HttpHeaders, RequestOptions).
`QueryResult`	`executeQuery(DataQuery query, HttpHeaders headers)` See executeQuery(DataQuery, HttpHeaders, RequestOptions).
`QueryResult`	`executeQuery(DataQuery query, HttpHeaders headers, RequestOptions options)` Execute a data query to get data from the target system.
`void`	`expandItem(EntityValue entity, ExpandItem item)` Override this function to implement item expansion for this service.
`void`	`expandItems(DataQuery query, DataValue result)` If `query` contains any `DataQuery.expandItems`, apply them to `result`.
`CsdlDocument`	`fetchMetadata(HttpHeaders headers, RequestOptions options)` Fetch latest service metadata and return it, but don't change the `SQLDatabaseProvider.metadata` property.
`boolean`	`getAllowNonUtcTimeZone()` Return can the database clock be configured with a time zone other than UTC? Defaults to `false`.
`boolean`	`getAutoBindEntities()` Return should this provider automatically bind entities in `SQLDatabaseProvider.createEntity` or `SQLDatabaseProvider.updateEntity`, if bound entities are provided by the client.
`boolean`	`getAutoCreateChildren()` Return should this provider automatically create children in `SQLDatabaseProvider.createEntity` ("deep insert" calls), if nested children are provided by the client.
`boolean`	`getAutoCreateParents()` Return should this provider automatically create parents in `SQLDatabaseProvider.createEntity` ("deep insert" calls), if nested parents are provided by the client.
`boolean`	`getAutoDeleteChildren()` Return should this provider automatically delete children in `SQLDatabaseProvider.deleteEntity` ("on delete" actions), if specified with OnDelete in the service metadata.
`boolean`	`getAutoExpandItems()` Return should this provider automatically expand itemns in `SQLDatabaseProvider.executeQuery`, if requested in the client's query.
`boolean`	`getAutoGenerateKeys()` Return should this provider automatically generate primary keys? Defaults to `true`.
`boolean`	`getAutoUnbindEntities()` Return should this provider automatically unbind entities in `SQLDatabaseProvider.createEntity` or `SQLDatabaseProvider.updateEntity`, if unbound entities are provided by the client.
`int`	`getCacheOldestTransactionForSeconds()` Return when determining the start time of the oldest active database transaction for change tracking queries, how long can a cached transaction time be used for? Defaults to `5`.
`boolean`	`getCanModifySchema()` Return is this provider permitted to modify the database schema, e.g.
`DayTimeDuration`	`getClientExpiryInterval()` Return if `SQLDatabaseProvider.startClientExpiryThread` is called, how often should it perform cleanup activity? Defaults to one hour.
`void`	`getConnection()` If the current thread is not connected to this database, then connect it.
`DataTransaction`	`getDataTransaction()` Return the current server transaction.
`boolean`	`getDebugConnections()` Return should all connections (opening/closing) to this SQL database service be logged? Defaults to `false`.
`DayTimeDuration`	`getDeltaCleanupInterval()` Return if `SQLDatabaseProvider.startDeltaCleanupThread` is called, how often should it perform cleanup activity? Defaults to one hour.
`int`	`getDownloadBeforeOldestTransaction()` Return when determining the next "last download" time for delta downloads, how many seconds should it be prior to the start time of the oldest active database transaction? Defaults to `5`.
`boolean`	`getEnableChangeTracking()` Return should this provider be enabled for change tracking? Defaults to `false`.
`boolean`	`getEnableKeyTracking()` Return should this provider use key tracking for determining when "delete" is required in delta responses? Defaults to `false`.
`boolean`	`getEnableRowVersioning()` Return should this provider be enabled for row versioning? Defaults to `false`.
`boolean`	`getFlattenComplexProperties()` Return should complex properties be flattened into separate columns for database storage? Defaults to `false`.
`boolean`	`getGenerateForeignKeyConstraints()` Return should the provider generate `foreign key` constraints when it creates database tables? Defaults to `false`.
`boolean`	`getGenerateUniqueConstraints()` Return should the provider generate `unique` constraints when it creates database tables? Defaults to `false`.
`boolean`	`getLogExceptions()` Return should all database exceptions be logged?
`boolean`	`getMaintainTrackingColumns()` Return should this provider maintain delta-tracking columns? Defaults to `false`.
`boolean`	`getMaintainVersionColumns()` Return should this provider maintain the row version column? Defaults to `false`.
`CsdlDocument`	`getMetadata()` Return service metadata.
`boolean`	`getOldestTransactionForAllDatabases()` Return when determining the start time of the oldest active database transaction for change tracking queries, should the oldest active transaction time for all databases be used? Defaults to `false`, so that only the current database (or current schema, if applicable) is considered.
`DayTimeDuration`	`getRetainDeletionsFor()` Return if change tracking is enabled, how long should logically deleted rows be retained to support subsequent delta queries? Defaults to 50 days.
`boolean`	`getSelectAfterCreate()` Return should entities be reselected after `SQLDatabaseProvider.createEntity` (SQL insert)? Defaults to `true`.
`boolean`	`getSelectAfterUpdate()` Return should entities be reselected after `SQLDatabaseProvider.updateEntity` (SQL update)? Defaults to `true`.
`java.lang.String`	`getServiceName()` Return service name.
`int`	`getStatementBatchSize()` Return batch size to be used for statement batching with this provider.
`StorageOptions`	`getStorageOptions()` Return options for database storage.
`boolean`	`getSupportsMultitenancy()` Return is this provider multi-tenant-aware? Defaults to `false`.
`java.lang.String`	`getThreadLocalTenant()` Return (nullable) ID of the current thread's tenant, if applicable.
`boolean`	`getTraceRequests()` Return should all requests for this SQL database service be traced? Defaults to `false`.
`boolean`	`getTraceWithData()` Return if `SQLDatabaseProvider.traceRequests` is also `true`, should all requests for this SQL database be traced with data? Defaults to `false`.
`boolean`	`getUseClientProvidedKeys()` Return should `SQLDatabaseProvider.createEntity` use client-provided keys (when available), in preference to server-generated keys? Defaults to `false`.
`boolean`	`hasMetadata()` Return has service metadata been loaded.
`boolean`	`isCacheDatabase()` Return is this database a cache (staging) database for a backend system? Defaults to `false`.
`boolean`	`isMetricProvider()` Return is this provider used for data metrics?
`void`	`loadMetadata(HttpHeaders headers, RequestOptions options)` Load service metadata (if not already loaded).
`java.lang.String`	`metadataText(int format)` Return metadata document text of the service.
`void`	`openSchema()` Open the database schema for this provider.
`void`	`openSchemaWithRetryLoop()` Open the database schema for this provider.
`void`	`pingServer(HttpHeaders headers, RequestOptions options)` Ping the server.
`void`	`prepareData(com.sap.cloud.server.odata.core.Action0 work)` Execute `work` within a transaction.
`void`	`prepareDataForTenant(com.sap.cloud.server.odata.core.Action0 work)` Execute a transaction to prepare data for the current tenant.
`void`	`processBatch(RequestBatch batch, HttpHeaders headers, RequestOptions options)` Execute a request batch in the target system.
`void`	`purgeAllDeletions()` Purge any logically-deleted rows (rows that were marked as deleted for change tracking), even those whose time of deletion does not exceed the `SQLDatabaseProvider.retainDeletionsFor` period.
`void`	`purgeDeletionsForTenant()` Purge any logically-deleted rows for the current tenant (rows that were marked as deleted for change tracking), even those whose time of deletion does not exceed the `SQLDatabaseProvider.retainDeletionsFor` period.
`void`	`purgeExpiredDeletions()` Purge any logically-deleted rows (rows that were marked as deleted for change tracking) whose time of deletion exceeds the `SQLDatabaseProvider.retainDeletionsFor` period.
`DataContext`	`queryContext(int version)` Return a data context for parsing a data query.
`void`	`rollback()` Rollback the current transaction.
`boolean`	`schemaExists()` Return `true` if the database schema artifacts (e.g.
`boolean`	`schemaExistsForTenant()` Return `true` if the database artifacts (e.g.
`EntityValue`	`selectEntity(EntityValue entity)` Return newly loaded copy of `entity` with all structural properties selected.
`java.lang.String`	`serviceDocument(int format)` Return the service document, in XML or JSON format.
`void`	`setAllowNonUtcTimeZone(boolean value)` Set can the database clock be configured with a time zone other than UTC? Defaults to `false`.
`void`	`setAutoBindEntities(boolean value)` Set should this provider automatically bind entities in `SQLDatabaseProvider.createEntity` or `SQLDatabaseProvider.updateEntity`, if bound entities are provided by the client.
`void`	`setAutoCreateChildren(boolean value)` Set should this provider automatically create children in `SQLDatabaseProvider.createEntity` ("deep insert" calls), if nested children are provided by the client.
`void`	`setAutoCreateParents(boolean value)` Set should this provider automatically create parents in `SQLDatabaseProvider.createEntity` ("deep insert" calls), if nested parents are provided by the client.
`void`	`setAutoDeleteChildren(boolean value)` Set should this provider automatically delete children in `SQLDatabaseProvider.deleteEntity` ("on delete" actions), if specified with OnDelete in the service metadata.
`void`	`setAutoExpandItems(boolean value)` Set should this provider automatically expand itemns in `SQLDatabaseProvider.executeQuery`, if requested in the client's query.
`void`	`setAutoGenerateKeys(boolean value)` Set should this provider automatically generate primary keys? Defaults to `true`.
`void`	`setAutoUnbindEntities(boolean value)` Set should this provider automatically unbind entities in `SQLDatabaseProvider.createEntity` or `SQLDatabaseProvider.updateEntity`, if unbound entities are provided by the client.
`void`	`setCacheDatabase(boolean value)` Set is this database a cache (staging) database for a backend system? Defaults to `false`.
`void`	`setCacheOldestTransactionForSeconds(int value)` Set when determining the start time of the oldest active database transaction for change tracking queries, how long can a cached transaction time be used for? Defaults to `5`.
`void`	`setCanModifySchema(boolean value)` Set is this provider permitted to modify the database schema, e.g.
`void`	`setClientExpiryInterval(DayTimeDuration value)` Set if `SQLDatabaseProvider.startClientExpiryThread` is called, how often should it perform cleanup activity? Defaults to one hour.
`void`	`setDebugConnections(boolean value)` Set should all connections (opening/closing) to this SQL database service be logged? Defaults to `false`.
`void`	`setDeltaCleanupInterval(DayTimeDuration value)` Set if `SQLDatabaseProvider.startDeltaCleanupThread` is called, how often should it perform cleanup activity? Defaults to one hour.
`void`	`setDownloadBeforeOldestTransaction(int value)` Set when determining the next "last download" time for delta downloads, how many seconds should it be prior to the start time of the oldest active database transaction? Defaults to `5`.
`void`	`setEnableChangeTracking(boolean value)` Set should this provider be enabled for change tracking? Defaults to `false`.
`void`	`setEnableKeyTracking(boolean value)` Set should this provider use key tracking for determining when "delete" is required in delta responses? Defaults to `false`.
`void`	`setEnableRowVersioning(boolean value)` Set should this provider be enabled for row versioning? Defaults to `false`.
`void`	`setFlattenComplexProperties(boolean value)` Set should complex properties be flattened into separate columns for database storage? Defaults to `false`.
`void`	`setGenerateForeignKeyConstraints(boolean value)` Set should the provider generate `foreign key` constraints when it creates database tables? Defaults to `false`.
`void`	`setGenerateUniqueConstraints(boolean value)` Set should the provider generate `unique` constraints when it creates database tables? Defaults to `false`.
`void`	`setInitialDataLoader(com.sap.cloud.server.odata.core.Action0 loader)` Register a callback handler which will be used for loading initial data into the database.
`void`	`setLogExceptions(boolean value)` Set should all database exceptions be logged?
`void`	`setMaintainTrackingColumns(boolean value)` Set should this provider maintain delta-tracking columns? Defaults to `false`.
`void`	`setMaintainVersionColumns(boolean value)` Set should this provider maintain the row version column? Defaults to `false`.
`void`	`setMetadata(CsdlDocument value)` Set service metadata.
`void`	`setMetricProvider(boolean value)` Set is this provider used for data metrics?
`void`	`setOldestTransactionForAllDatabases(boolean value)` Set when determining the start time of the oldest active database transaction for change tracking queries, should the oldest active transaction time for all databases be used? Defaults to `false`, so that only the current database (or current schema, if applicable) is considered.
`void`	`setRetainDeletionsFor(DayTimeDuration value)` Set if change tracking is enabled, how long should logically deleted rows be retained to support subsequent delta queries? Defaults to 50 days.
`void`	`setSelectAfterCreate(boolean value)` Set should entities be reselected after `SQLDatabaseProvider.createEntity` (SQL insert)? Defaults to `true`.
`void`	`setSelectAfterUpdate(boolean value)` Set should entities be reselected after `SQLDatabaseProvider.updateEntity` (SQL update)? Defaults to `true`.
`void`	`setStatementBatchSize(int value)` Set batch size to be used for statement batching with this provider.
`void`	`setSupportsMultitenancy(boolean value)` Set is this provider multi-tenant-aware? Defaults to `false`.
`void`	`setThreadLocalTenant(java.lang.String value)` Set ID of the current thread's tenant, if applicable.
`void`	`setTraceRequests(boolean value)` Set should all requests for this SQL database service be traced? Defaults to `false`.
`void`	`setTraceWithData(boolean value)` Set if `SQLDatabaseProvider.traceRequests` is also `true`, should all requests for this SQL database be traced with data? Defaults to `false`.
`void`	`setUseClientProvidedKeys(boolean value)` Set should `SQLDatabaseProvider.createEntity` use client-provided keys (when available), in preference to server-generated keys? Defaults to `false`.
`void`	`startClientExpiryThread(com.sap.cloud.server.odata.core.ThreadShutdown shutdown)` Start a thread which will periodically delete expired clients and related client-specific data.
`void`	`startDeltaCleanupThread(com.sap.cloud.server.odata.core.ThreadShutdown shutdown)` Start a thread which will periodically purge expired deletions.
`DataMethod`	`storedProcedure(java.lang.String name)` Return a data method for use in the execution of a database stored procedure.
`void`	`transaction(com.sap.cloud.server.odata.core.Action0 work)` Perform some work within a database transaction.
`void`	`unbindEntities(EntityValue entity)` See unbindEntities(EntityValue, Property).
`void`	`unbindEntities(EntityValue entity, Property bindingProperty)` This function may be used in the implementation of entity binding calls, e.g.
`void`	`unloadMetadata()` Unload service metadata (if previously loaded).
`void`	`updateClientExpiry(EntityValue registration)` Arrange for client expiry after a client registration has been created.
`void`	`updateEntity(EntityValue entity)` See updateEntity(EntityValue, HttpHeaders, RequestOptions).
`void`	`updateEntity(EntityValue entity, HttpHeaders headers)` See updateEntity(EntityValue, HttpHeaders, RequestOptions).
`void`	`updateEntity(EntityValue entity, HttpHeaders headers, RequestOptions options)` Update an entity in the target system.
`java.lang.RuntimeException`	`updateEntityReturningError(EntityValue entity)` See updateEntityReturningError(EntityValue, HttpHeaders, RequestOptions).
`java.lang.RuntimeException`	`updateEntityReturningError(EntityValue entity, HttpHeaders headers)` See updateEntityReturningError(EntityValue, HttpHeaders, RequestOptions).
`java.lang.RuntimeException`	`updateEntityReturningError(EntityValue entity, HttpHeaders headers, RequestOptions options)` Call `SQLDatabaseProvider.createEntity` but catch any excepion it throws (non-logged) and return it.
`void`	`updateLink(EntityValue from, Property property, EntityValue to)` See updateLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).
`void`	`updateLink(EntityValue from, Property property, EntityValue to, HttpHeaders headers)` See updateLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).
`void`	`updateLink(EntityValue from, Property property, EntityValue to, HttpHeaders headers, RequestOptions options)` Update a link from a source entity to a target entity.
`void`	`updateLinkUsingForeignKeys(EntityValue source, Property sourceProperty, EntityValue target)` Default implementation of 'updateLink' using foreign keys from referential constraints in service metadata.
`void`	`uploadMedia(EntityValue entity, StreamBase content)` See uploadMedia(EntityValue, StreamBase, HttpHeaders, RequestOptions).
`void`	`uploadMedia(EntityValue entity, StreamBase content, HttpHeaders headers)` See uploadMedia(EntityValue, StreamBase, HttpHeaders, RequestOptions).
`void`	`uploadMedia(EntityValue entity, StreamBase content, HttpHeaders headers, RequestOptions options)` Upload content for a media entity to the target system Caution: Having too many threads simultaneously uploading streams may result in out-of-memory conditions on memory-constrained devices.
`void`	`uploadStream(EntityValue entity, StreamLink link, StreamBase content)` See uploadStream(EntityValue, StreamLink, StreamBase, HttpHeaders, RequestOptions).
`void`	`uploadStream(EntityValue entity, StreamLink link, StreamBase content, HttpHeaders headers)` See uploadStream(EntityValue, StreamLink, StreamBase, HttpHeaders, RequestOptions).
`void`	`uploadStream(EntityValue entity, StreamLink link, StreamBase content, HttpHeaders headers, RequestOptions options)` Upload content for a stream property to the target system.
`SQLDatabaseProvider`	`withDataSource(javax.sql.DataSource dataSource)` Initialises the JDBC data source within storageOptions.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SQLDatabaseProvider
```
public SQLDatabaseProvider(java.lang.String serviceName)
```
    See SQLDatabaseProvider(String, String).
    
    Parameters:
    
    serviceName - ServiceName parameter.
  - SQLDatabaseProvider
```
public SQLDatabaseProvider(java.lang.String serviceName,
                           java.lang.String databaseURL)
```
    Constructs a SQL database provider.
    
    Parameters:
    
    serviceName - Service name.
    
    databaseURL - (nullable) Database URL.
- Method Detail
  - withDataSource
```
public SQLDatabaseProvider withDataSource(javax.sql.DataSource dataSource)
```
    Initialises the JDBC data source within storageOptions.
    
    Parameters:
    
    dataSource - JDBC data source.
    
    Returns:
    
    This provider.
  - applyChanges
```
public void applyChanges(ChangeSet changes)
```
    See applyChanges(ChangeSet, HttpHeaders, RequestOptions).
    
    Parameters:
    
    changes - Changes parameter.
  - applyChanges
```
public void applyChanges(ChangeSet changes,
                         HttpHeaders headers)
```
    See applyChanges(ChangeSet, HttpHeaders, RequestOptions).
    
    Parameters:
    
    changes - Changes parameter.
    
    headers - Headers parameter.
  - applyChanges
```
public void applyChanges(ChangeSet changes,
                         HttpHeaders headers,
                         RequestOptions options)
```
    Apply the changes from a change set to the target system.
    
    See Also:
    
    SQLDatabaseProvider.processBatch.
    
    Parameters:
    
    changes - The change set.
    
    headers - Optional request-specific headers.
    
    options - Optional request-specific options.
  - beginTransaction
```
public void beginTransaction()
```
    Begin a new transaction, or begin a nested transaction if a transaction is already active for this provider in the current thread.
    
    Specified by:
    
    beginTransaction in interface DataServiceProvider
  - bindEntities
```
public void bindEntities(EntityValue entity)
```
    See bindEntities(EntityValue, Property, boolean, boolean).
    
    Parameters:
    
    entity - Entity parameter.
  - bindEntities
```
public void bindEntities(EntityValue entity,
                         Property bindingProperty)
```
    See bindEntities(EntityValue, Property, boolean, boolean).
    
    Parameters:
    
    entity - Entity parameter.
    
    bindingProperty - BindingProperty parameter.
  - bindEntities
```
public void bindEntities(EntityValue entity,
                         Property bindingProperty,
                         boolean afterCreate)
```
    See bindEntities(EntityValue, Property, boolean, boolean).
    
    Parameters:
    
    entity - Entity parameter.
    
    bindingProperty - BindingProperty parameter.
    
    afterCreate - AfterCreate parameter.
  - bindEntities
```
public void bindEntities(EntityValue entity,
                         Property bindingProperty,
                         boolean afterCreate,
                         boolean afterUpdate)
```
    This function may be used in the implementation of entity binding calls, e.g. by EntityValue.bindEntity. It relies on the existence of appropriate referential constraints in the service metadata, or an appropriately set join entity set.
    
    Parameters:
    
    entity - Source entity, which may contain inline bindings for the binding property.
    
    bindingProperty - (nullable) Binding property. If null, then all of the source's navigation properties are considered.
    
    afterCreate - Is this call for binding after createEntity has created entity? Defaults to false.
    
    afterUpdate - Is this call for binding after updateEntity has updated entity? Defaults to false.
  - bindEntitiesAfterCreate
```
public void bindEntitiesAfterCreate(EntityValue entity)
```
    See bindEntitiesAfterCreate(EntityValue, Property).
    
    Parameters:
    
    entity - Entity parameter.
  - bindEntitiesAfterCreate
```
public void bindEntitiesAfterCreate(EntityValue entity,
                                    Property bindingProperty)
```
    This function may be used in the implementation of entity binding calls after the main create action of SQLDatabaseProvider.createEntity. It relies on the existence of appropriate referential constraints in the service metadata.
    
    Parameters:
    
    entity - Source entity, which may contain inline bindings for the binding property.
    
    bindingProperty - (nullable) Binding property. If null, then all of the source's navigation properties are considered.
  - bindEntitiesAfterUpdate
```
public void bindEntitiesAfterUpdate(EntityValue entity)
```
    See bindEntitiesAfterUpdate(EntityValue, Property).
    
    Parameters:
    
    entity - Entity parameter.
  - bindEntitiesAfterUpdate
```
public void bindEntitiesAfterUpdate(EntityValue entity,
                                    Property bindingProperty)
```
    This function may be used in the implementation of entity binding calls after the main update action of SQLDatabaseProvider.updateEntity. It relies on the existence of appropriate referential constraints in the service metadata.
    
    Parameters:
    
    entity - Source entity, which may contain inline bindings for the binding property.
    
    bindingProperty - (nullable) Binding property. If null, then all of the source's navigation properties are considered.
  - closeAllConnections
```
public void closeAllConnections()
```
    Close connections to this database from all threads. Note: in some environments (e.g. an application server with contained-managed connection pooling), this might not have any effect on pooled connections.
  - closeConnection
```
public void closeConnection()
```
    If the current thread is connected to this database, then disconnect it.
  - commit
```
public void commit()
```
    Commit the current transaction. If the current transaction is a nested transaction, then decrease the nesting level.
    
    Specified by:
    
    commit in interface DataServiceProvider
  - createChildren
```
public void createChildren(EntityValue entity)
```
    See createChildren(EntityValue, Property).
    
    Parameters:
    
    entity - Entity parameter.
  - createChildren
```
public void createChildren(EntityValue entity,
                           Property childProperty)
```
    This function may be used in the implementation of "deep insert" calls, e.g. by SQLDatabaseProvider.createEntity. This function will execute "deep insert" if the parent-child entity relationship is fulfilled through join set.
    
    Parameters:
    
    entity - Parent entity, which may contain inline children for the child property.
    
    childProperty - (nullable) Child property. If null, then all of the parent's navigation properties are considered.
  - createClientExpiry
```
public void createClientExpiry(EntityValue registration)
```
    Arrange for client expiry after a client registration has been created.
    
    See Also:
    
    SQLDatabaseProvider.retainDeletionsFor, which also determines how long inactive client registrations will be retained.
    
    Parameters:
    
    registration - Client registration.
  - createEntity
```
public void createEntity(EntityValue entity)
```
    See createEntity(EntityValue, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
  - createEntity
```
public void createEntity(EntityValue entity,
                         HttpHeaders headers)
```
    See createEntity(EntityValue, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
    
    headers - Headers parameter.
  - createEntity
```
public void createEntity(EntityValue entity,
                         HttpHeaders headers,
                         RequestOptions options)
```
    Create an entity in the target system. Automatically calls CsdlDocument.resolveEntity to ensure that EntityValue.entitySet is available.
    
    Throws:
    
    DataServiceException if the entity set hasn't been explicitly provided before calling createEntity and there isn't a unique entity set for the entity type.
    
    See Also:
    
    EntityValue.ofType, EntityValue.inSet.
    
    Specified by:
    
    createEntity in interface DataServiceProvider
    
    Parameters:
    
    entity - Entity to be created.
    
    headers - Request-specific headers.
    
    options - Request-specific options.
  - createEntityReturningError
```
public java.lang.RuntimeException createEntityReturningError(EntityValue entity)
```
    See createEntityReturningError(EntityValue, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
    
    Returns:
    
    (see linked method).
  - createEntityReturningError
```
public java.lang.RuntimeException createEntityReturningError(EntityValue entity,
                                                             HttpHeaders headers)
```
    See createEntityReturningError(EntityValue, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
    
    headers - Headers parameter.
    
    Returns:
    
    (see linked method).
  - createEntityReturningError
```
public java.lang.RuntimeException createEntityReturningError(EntityValue entity,
                                                             HttpHeaders headers,
                                                             RequestOptions options)
```
    Call SQLDatabaseProvider.createEntity but catch any excepion it throws (non-logged) and return it.
    
    Parameters:
    
    entity - Entity to be created.
    
    headers - Request-specific headers.
    
    options - Request-specific options.
    
    Returns:
    
    (nullable) Caught error, if any. (The error will not be logged).
  - createLink
```
public void createLink(EntityValue from,
                       Property property,
                       EntityValue to)
```
    See createLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).
    
    Parameters:
    
    from - From parameter.
    
    property - Property parameter.
    
    to - To parameter.
  - createLink
```
public void createLink(EntityValue from,
                       Property property,
                       EntityValue to,
                       HttpHeaders headers)
```
    See createLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).
    
    Parameters:
    
    from - From parameter.
    
    property - Property parameter.
    
    to - To parameter.
    
    headers - Headers parameter.
  - createLink
```
public void createLink(EntityValue from,
                       Property property,
                       EntityValue to,
                       HttpHeaders headers,
                       RequestOptions options)
```
    Create a link from a source entity to a target entity.
    
    Specified by:
    
    createLink in interface DataServiceProvider
    
    Parameters:
    
    from - Source entity for the link to be created.
    
    property - Source navigation property for the link to be created.
    
    to - Target entity for the link to be created.
    
    headers - Request-specific headers.
    
    options - Request-specific options.
  - createLinkUsingForeignKeys
```
public void createLinkUsingForeignKeys(EntityValue source,
                                       Property sourceProperty,
                                       EntityValue target)
```
    Default implementation of 'createLink' using foreign keys from referential constraints in service metadata.
    
    Parameters:
    
    source - Source entity for the link to be created.
    
    sourceProperty - Source navigation property for the link to be created. This may be a one-to-one or one-to-many navigation property.
    
    target - Target entity for the link to be created.
  - createMedia
```
public void createMedia(EntityValue entity,
                        StreamBase content)
```
    See createMedia(EntityValue, StreamBase, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
    
    content - Content parameter.
  - createMedia
```
public void createMedia(EntityValue entity,
                        StreamBase content,
                        HttpHeaders headers)
```
    See createMedia(EntityValue, StreamBase, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
    
    content - Content parameter.
    
    headers - Headers parameter.
  - createMedia
```
public void createMedia(EntityValue entity,
                        StreamBase content,
                        HttpHeaders headers,
                        RequestOptions options)
```
    Create a media entity with the specified content in the target system. If the entity has non-stream structural properties in addition to the key properties and media content, such as label in the examples below, then this function will send two requests to the server: a first request to upload (POST) the media stream, and a second request (PATCH/PUT) to update the non-stream properties. It is not currently supported to make these two calls atomic. Caution: Having too many threads simultaneously creating streams may result in out-of-memory conditions on memory-constrained devices.
    
    Specified by:
    
    createMedia in interface DataServiceProvider
    
    Parameters:
    
    entity - Entity to be created.
    
    content - Initial content. Must be a ByteStream or CharStream. Will be closed before this function returns.
    
    headers - Request-specific headers.
    
    options - Request-specific options.
  - createParents
```
public void createParents(EntityValue entity)
```
    See createParents(EntityValue, Property).
    
    Parameters:
    
    entity - Entity parameter.
  - createParents
```
public void createParents(EntityValue entity,
                          Property parentProperty)
```
    This function may be used in the implementation of "deep insert" calls, e.g. by SQLDatabaseProvider.createEntity. This function will not execute "deep insert" if the parent-child entity relationship is fulfilled through join set.
    
    Parameters:
    
    entity - Child entity, which may contain inline parent(s) via the parent property.
    
    parentProperty - (nullable) Child property. If null, then all of the parent's navigation properties are considered.
  - createSchema
```
public void createSchema()
```
    Create (if non-existent) the database schema artifacts (e.g. tables) for this provider.
  - createSchemaForTenant
```
public void createSchemaForTenant()
```
    Create (if non-existent) the database artifacts (e.g. rows) in this database for the current tenant.
    
    See Also:
    
    SQLDatabaseProvider.supportsMultitenancy.
  - createSchemaWithRetryLoop
```
public void createSchemaWithRetryLoop()
```
    Create (if non-existent) the database schema artifacts (e.g. tables) for this provider. If creation fails, then retry (potentially forever) with a one minute delay between retries.
  - currentLDT
```
public GlobalDateTime currentLDT()
```
    Return the current local date/time according to the database server.
    
    Returns:
    
    the current local date/time according to the database server.
  - currentUTC
```
public GlobalDateTime currentUTC()
```
    Return the current global time (UTC) according to the database server.
    
    Returns:
    
    the current global time (UTC) according to the database server.
  - deleteByQuery
```
public void deleteByQuery(DataQuery query)
```
    See deleteByQuery(DataQuery, HttpHeaders, RequestOptions).
    
    Parameters:
    
    query - Query parameter.
  - deleteByQuery
```
public void deleteByQuery(DataQuery query,
                          HttpHeaders headers)
```
    See deleteByQuery(DataQuery, HttpHeaders, RequestOptions).
    
    Parameters:
    
    query - Query parameter.
    
    headers - Headers parameter.
  - deleteByQuery
```
public void deleteByQuery(DataQuery query,
                          HttpHeaders headers,
                          RequestOptions options)
```
    Execute query to delete data from the target system.
    
    Specified by:
    
    deleteByQuery in interface DataServiceProvider
    
    Parameters:
    
    query - Data query specifying the information to be deleted.
    
    headers - Request-specific headers.
    
    options - Request-specific options.
  - deleteChildren
```
public void deleteChildren(EntityValue entity)
```
    See deleteChildren(EntityValue, Property).
    
    Parameters:
    
    entity - Entity parameter.
  - deleteChildren
```
public void deleteChildren(EntityValue entity,
                           Property childProperty)
```
    This function may be used in the implementation of "on delete" actions, e.g. by SQLDatabaseProvider.deleteEntity.
    
    See Also:
    
    SQLDatabaseProvider.deleteEntity, Property.onDeleteAction.
    
    Parameters:
    
    entity - Parent entity.
    
    childProperty - (nullable) Child property. If `null`, then all of the parent's navigation properties are considered.
  - deleteEntity
```
public void deleteEntity(EntityValue entity)
```
    See deleteEntity(EntityValue, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
  - deleteEntity
```
public void deleteEntity(EntityValue entity,
                         HttpHeaders headers)
```
    See deleteEntity(EntityValue, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
    
    headers - Headers parameter.
  - deleteEntity
```
public void deleteEntity(EntityValue entity,
                         HttpHeaders headers,
                         RequestOptions options)
```
    Delete an entity from the target system.
    
    Specified by:
    
    deleteEntity in interface DataServiceProvider
    
    Parameters:
    
    entity - Entity to be deleted.
    
    headers - Request-specific headers.
    
    options - Request-specific options.
  - deleteEntityReturningError
```
public java.lang.RuntimeException deleteEntityReturningError(EntityValue entity)
```
    See deleteEntityReturningError(EntityValue, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
    
    Returns:
    
    (see linked method).
  - deleteEntityReturningError
```
public java.lang.RuntimeException deleteEntityReturningError(EntityValue entity,
                                                             HttpHeaders headers)
```
    See deleteEntityReturningError(EntityValue, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
    
    headers - Headers parameter.
    
    Returns:
    
    (see linked method).
  - deleteEntityReturningError
```
public java.lang.RuntimeException deleteEntityReturningError(EntityValue entity,
                                                             HttpHeaders headers,
                                                             RequestOptions options)
```
    Call SQLDatabaseProvider.deleteEntity but catch any excepion it throws (non-logged) and return it.
    
    Parameters:
    
    entity - Entity to be deleted.
    
    headers - Request-specific headers.
    
    options - Request-specific options.
    
    Returns:
    
    (nullable) Caught error, if any. (The error will not be logged).
  - deleteLink
```
public void deleteLink(EntityValue from,
                       Property property,
                       EntityValue to)
```
    See deleteLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).
    
    Parameters:
    
    from - From parameter.
    
    property - Property parameter.
    
    to - To parameter.
  - deleteLink
```
public void deleteLink(EntityValue from,
                       Property property,
                       EntityValue to,
                       HttpHeaders headers)
```
    See deleteLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).
    
    Parameters:
    
    from - From parameter.
    
    property - Property parameter.
    
    to - To parameter.
    
    headers - Headers parameter.
  - deleteLink
```
public void deleteLink(EntityValue from,
                       Property property,
                       EntityValue to,
                       HttpHeaders headers,
                       RequestOptions options)
```
    Delete a link from a source entity to a target entity.
    
    Specified by:
    
    deleteLink in interface DataServiceProvider
    
    Parameters:
    
    from - Source entity for the link to be deleted.
    
    property - Source navigation property for the link to be deleted.
    
    to - Target entity for the link to be deleted.
    
    headers - Request-specific headers.
    
    options - Request-specific options.
  - deleteLinkUsingForeignKeys
```
public void deleteLinkUsingForeignKeys(EntityValue source,
                                       Property sourceProperty,
                                       EntityValue target)
```
    Default implementation of 'deleteLink' using foreign keys from referential constraints in service metadata.
    
    Parameters:
    
    source - Source entity for the link to be created.
    
    sourceProperty - Source navigation property for the link to be created. This may be a one-to-one or one-to-many navigation property.
    
    target - Target entity for the link to be created.
  - deleteSchema
```
public void deleteSchema()
```
    Delete (if existing) the database schema artifacts (e.g. tables) for this provider.
  - deleteSchemaForTenant
```
public void deleteSchemaForTenant()
```
    Delete (if existing) the database artifacts (e.g. rows) in this database for the current tenant.
    
    See Also:
    
    SQLDatabaseProvider.supportsMultitenancy.
  - deleteStream
```
public void deleteStream(EntityValue entity,
                         StreamLink link)
```
    See deleteStream(EntityValue, StreamLink, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
    
    link - Link parameter.
  - deleteStream
```
public void deleteStream(EntityValue entity,
                         StreamLink link,
                         HttpHeaders headers)
```
    See deleteStream(EntityValue, StreamLink, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
    
    link - Link parameter.
    
    headers - Headers parameter.
  - deleteStream
```
public void deleteStream(EntityValue entity,
                         StreamLink link,
                         HttpHeaders headers,
                         RequestOptions options)
```
    Delete the content of a stream property from the target system.
    
    Specified by:
    
    deleteStream in interface DataServiceProvider
    
    Parameters:
    
    entity - Entity containing the stream property whose content is to be deleted.
    
    headers - Request-specific headers.
    
    options - Request-specific options.
    
    link - Stream link for the stream to be deleted.
  - downloadMedia
```
public ByteStream downloadMedia(EntityValue entity)
```
    See downloadMedia(EntityValue, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
    
    Returns:
    
    (see linked method).
  - downloadMedia
```
public ByteStream downloadMedia(EntityValue entity,
                                HttpHeaders headers)
```
    See downloadMedia(EntityValue, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
    
    headers - Headers parameter.
    
    Returns:
    
    (see linked method).
  - downloadMedia
```
public ByteStream downloadMedia(EntityValue entity,
                                HttpHeaders headers,
                                RequestOptions options)
```
    Obtain a stream for downloading the content of a media entity from the target system. Caution: streams are often used for large content that may not fit (all at once) in available application memory. Having too many threads simultaneously downloading streams, or using ByteStream.readAndClose, may result in out-of-memory conditions on memory-constrained devices.
    
    Specified by:
    
    downloadMedia in interface DataServiceProvider
    
    Parameters:
    
    entity - Entity whose content is to be downloaded.
    
    headers - Request-specific headers.
    
    options - Request-specific options.
    
    Returns:
    
    A stream for downloading the content of a media entity. This must be closed by the caller, or else a resource leak may occur.
  - downloadStream
```
public ByteStream downloadStream(EntityValue entity,
                                 StreamLink link)
```
    See downloadStream(EntityValue, StreamLink, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
    
    link - Link parameter.
    
    Returns:
    
    (see linked method).
  - downloadStream
```
public ByteStream downloadStream(EntityValue entity,
                                 StreamLink link,
                                 HttpHeaders headers)
```
    See downloadStream(EntityValue, StreamLink, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
    
    link - Link parameter.
    
    headers - Headers parameter.
    
    Returns:
    
    (see linked method).
  - downloadStream
```
public ByteStream downloadStream(EntityValue entity,
                                 StreamLink link,
                                 HttpHeaders headers,
                                 RequestOptions options)
```
    Obtain a stream for downloading the content of a stream property from the target system. Caution: streams are often used for large content that may not fit (all at once) in available application memory. Having too many threads simultaneously downloading streams, or using ByteStream.readAndClose, may result in out-of-memory conditions on memory-constrained devices.
    
    See Also:
    
    Property.getStreamLink.
    
    Specified by:
    
    downloadStream in interface DataServiceProvider
    
    Parameters:
    
    entity - Entity containing the stream property whose content is to be downloaded.
    
    link - Stream link for the stream to be downloaded.
    
    headers - Request-specific headers.
    
    options - Request-specific options.
    
    Returns:
    
    A stream for downloading the content of a stream property. This must be closed by the caller, or else a resource leak may occur.
  - entityContext
```
public DataContext entityContext(EntitySet entitySet,
                                 StructureType derivedType,
                                 int format,
                                 int version)
```
    Return a data context for a specified entity set, data format and data version.
    
    See Also:
    
    DataFormat, DataVersion.
    
    Specified by:
    
    entityContext in interface DataServiceProvider
    
    Parameters:
    
    entitySet - Entity set for entity value to be parsed or formatted.
    
    derivedType - (nullable) Derived type for query results.
    
    format - Data format.
    
    version - Data version.
    
    Returns:
    
    A data context for a specified entity set, data format and data version.
  - executeBatch
```
public void executeBatch()
```
    If the current thread's connection has batched statements, execute them now.
  - executeMethod
```
public DataValue executeMethod(DataMethod method,
                               ParameterList parameters)
```
    See executeMethod(DataMethod, ParameterList, HttpHeaders, RequestOptions).
    
    Parameters:
    
    method - Method parameter.
    
    parameters - Parameters parameter.
    
    Returns:
    
    (see linked method).
  - executeMethod
```
public DataValue executeMethod(DataMethod method,
                               ParameterList parameters,
                               HttpHeaders headers)
```
    See executeMethod(DataMethod, ParameterList, HttpHeaders, RequestOptions).
    
    Parameters:
    
    method - Method parameter.
    
    parameters - Parameters parameter.
    
    headers - Headers parameter.
    
    Returns:
    
    (see linked method).
  - executeMethod
```
public DataValue executeMethod(DataMethod method,
                               ParameterList parameters,
                               HttpHeaders headers,
                               RequestOptions options)
```
    Execute a data method (action or function) in the target system. Actions may have backend side-effects. Functions should not have backend side-effects.
    
    Throws:
    
    DataServiceException or DataNetworkException if an error occurs during action invocation.
    
    Specified by:
    
    executeMethod in interface DataServiceProvider
    
    Parameters:
    
    method - Data method.
    
    parameters - Method parameters.
    
    headers - Request-specific headers.
    
    options - Request-specific options.
    
    Returns:
    
    (nullable) The method result, or `null` if the method has no result.
  - executeQuery
```
public QueryResult executeQuery(DataQuery query)
```
    See executeQuery(DataQuery, HttpHeaders, RequestOptions).
    
    Parameters:
    
    query - Query parameter.
    
    Returns:
    
    (see linked method).
  - executeQuery
```
public QueryResult executeQuery(DataQuery query,
                                HttpHeaders headers)
```
    See executeQuery(DataQuery, HttpHeaders, RequestOptions).
    
    Parameters:
    
    query - Query parameter.
    
    headers - Headers parameter.
    
    Returns:
    
    (see linked method).
  - executeQuery
```
public QueryResult executeQuery(DataQuery query,
                                HttpHeaders headers,
                                RequestOptions options)
```
    Execute a data query to get data from the target system.
    
    Specified by:
    
    executeQuery in interface DataServiceProvider
    
    Parameters:
    
    query - Data query specifying the information to be returned.
    
    headers - Request-specific headers.
    
    options - Request-specific options.
    
    Returns:
    
    The query result.
  - expandItem
```
public void expandItem(EntityValue entity,
                       ExpandItem item)
```
    Override this function to implement item expansion for this service. If not overridden, referential constraints are used to implement automatic expansion.
    
    Parameters:
    
    entity - Entity whose item is to be expanded.
    
    item - Item to be expanded.
  - expandItems
```
public void expandItems(DataQuery query,
                        DataValue result)
```
    If query contains any DataQuery.expandItems, apply them to result.
    
    Parameters:
    
    query - Query which may optionally contain expand items.
    
    result - (nullable) Query result, to which item expansion may be applied (if not null, the result should be an entity value or entity list).
  - fetchMetadata
```
public CsdlDocument fetchMetadata(HttpHeaders headers,
                                  RequestOptions options)
```
    Fetch latest service metadata and return it, but don't change the SQLDatabaseProvider.metadata property.
    
    See Also:
    
    SQLDatabaseProvider.loadMetadata.
    
    Specified by:
    
    fetchMetadata in interface DataServiceProvider
    
    Parameters:
    
    headers - Optional request-specific headers.
    
    options - Optional request-specific options.
    
    Returns:
    
    Latest service metadata.
  - getAllowNonUtcTimeZone
```
public boolean getAllowNonUtcTimeZone()
```
    Return can the database clock be configured with a time zone other than UTC? Defaults to false.
    
    Returns:
    
    Can the database clock be configured with a time zone other than UTC? Defaults to false.
  - getAutoBindEntities
```
public boolean getAutoBindEntities()
```
    Return should this provider automatically bind entities in SQLDatabaseProvider.createEntity or SQLDatabaseProvider.updateEntity, if bound entities are provided by the client. Defaults to true.
    
    Returns:
    
    Should this provider automatically bind entities in SQLDatabaseProvider.createEntity or SQLDatabaseProvider.updateEntity, if bound entities are provided by the client. Defaults to true.
  - getAutoCreateChildren
```
public boolean getAutoCreateChildren()
```
    Return should this provider automatically create children in SQLDatabaseProvider.createEntity ("deep insert" calls), if nested children are provided by the client. Defaults to true.
    
    Returns:
    
    Should this provider automatically create children in SQLDatabaseProvider.createEntity ("deep insert" calls), if nested children are provided by the client. Defaults to true.
  - getAutoCreateParents
```
public boolean getAutoCreateParents()
```
    Return should this provider automatically create parents in SQLDatabaseProvider.createEntity ("deep insert" calls), if nested parents are provided by the client. Defaults to true.
    
    Returns:
    
    Should this provider automatically create parents in SQLDatabaseProvider.createEntity ("deep insert" calls), if nested parents are provided by the client. Defaults to true.
  - getAutoDeleteChildren
```
public boolean getAutoDeleteChildren()
```
    Return should this provider automatically delete children in SQLDatabaseProvider.deleteEntity ("on delete" actions), if specified with OnDelete in the service metadata. Defaults to true.
    
    Returns:
    
    Should this provider automatically delete children in SQLDatabaseProvider.deleteEntity ("on delete" actions), if specified with OnDelete in the service metadata. Defaults to true.
  - getAutoExpandItems
```
public boolean getAutoExpandItems()
```
    Return should this provider automatically expand itemns in SQLDatabaseProvider.executeQuery, if requested in the client's query. Defaults to true.
    
    Returns:
    
    Should this provider automatically expand itemns in SQLDatabaseProvider.executeQuery, if requested in the client's query. Defaults to true.
  - getAutoGenerateKeys
```
public boolean getAutoGenerateKeys()
```
    Return should this provider automatically generate primary keys? Defaults to true. If the provider doesn't generate keys, then the client will have to provide them.
    
    See Also:
    
    SQLDatabaseProvider.useClientProvidedKeys.
    
    Returns:
    
    Should this provider automatically generate primary keys? Defaults to `true`.
  - getAutoUnbindEntities
```
public boolean getAutoUnbindEntities()
```
    Return should this provider automatically unbind entities in SQLDatabaseProvider.createEntity or SQLDatabaseProvider.updateEntity, if unbound entities are provided by the client. Defaults to true.
    
    Returns:
    
    Should this provider automatically unbind entities in SQLDatabaseProvider.createEntity or SQLDatabaseProvider.updateEntity, if unbound entities are provided by the client. Defaults to true.
  - getCacheOldestTransactionForSeconds
```
public int getCacheOldestTransactionForSeconds()
```
    Return when determining the start time of the oldest active database transaction for change tracking queries, how long can a cached transaction time be used for? Defaults to 5. Setting this value too high can result in clients downloading the same changes repeatedly (if the interval between client downloads is smaller than the caching interval). Setting this value too low can result in frequent database interactions to determine the start time of the oldest active transaction. Setting this value to zero (or negative) will disable caching of the start time of the oldest active transaction.
    
    Returns:
    
    When determining the start time of the oldest active database transaction for change tracking queries, how long can a cached transaction time be used for? Defaults to 5.
  - getCanModifySchema
```
public boolean getCanModifySchema()
```
    Return is this provider permitted to modify the database schema, e.g. by adding required tables? Defaults to true. If not enabled, then schema changes will need to be managed by the database administrator.
    
    Returns:
    
    Is this provider permitted to modify the database schema, e.g. by adding required tables? Defaults to true.
  - getClientExpiryInterval
```
public DayTimeDuration getClientExpiryInterval()
```
    Return if SQLDatabaseProvider.startClientExpiryThread is called, how often should it perform cleanup activity? Defaults to one hour. Intervals of less than one minute will be treated as one minute.
    
    Returns:
    
    If SQLDatabaseProvider.startClientExpiryThread is called, how often should it perform cleanup activity? Defaults to one hour.
  - getConnection
```
public void getConnection()
```
    If the current thread is not connected to this database, then connect it.
  - getDataTransaction
```
public DataTransaction getDataTransaction()
```
    Return the current server transaction.
    
    Specified by:
    
    getDataTransaction in interface DataServiceProvider
    
    Returns:
    
    The current server transaction.
  - getDebugConnections
```
public boolean getDebugConnections()
```
    Return should all connections (opening/closing) to this SQL database service be logged? Defaults to false.
    
    Returns:
    
    Should all connections (opening/closing) to this SQL database service be logged? Defaults to false.
  - getDeltaCleanupInterval
```
public DayTimeDuration getDeltaCleanupInterval()
```
    Return if SQLDatabaseProvider.startDeltaCleanupThread is called, how often should it perform cleanup activity? Defaults to one hour. Intervals of less than one minute will be treated as one minute.
    
    Returns:
    
    If SQLDatabaseProvider.startDeltaCleanupThread is called, how often should it perform cleanup activity? Defaults to one hour.
  - getDownloadBeforeOldestTransaction
```
public int getDownloadBeforeOldestTransaction()
```
    Return when determining the next "last download" time for delta downloads, how many seconds should it be prior to the start time of the oldest active database transaction? Defaults to 5. It is assumed that if the database server is clustered, the cluster nodes will be time-synchronized to within this interval.
    
    See Also:
    
    Network Time Protocol.
    
    Returns:
    
    When determining the next "last download" time for delta downloads, how many seconds should it be prior to the start time of the oldest active database transaction? Defaults to `5`.
  - getEnableChangeTracking
```
public boolean getEnableChangeTracking()
```
    Return should this provider be enabled for change tracking? Defaults to false.
    
    See Also:
    
    SQLDatabaseProvider.maintainTrackingColumns, EntitySet.trackChanges, StorageOptions.isDeletedColumn, StorageOptions.lastModifiedColumn.
    
    Returns:
    
    Should this provider be enabled for change tracking? Defaults to `false`.
  - getEnableKeyTracking
```
public boolean getEnableKeyTracking()
```
    Return should this provider use key tracking for determining when "delete" is required in delta responses? Defaults to false.
    
    Returns:
    
    Should this provider use key tracking for determining when "delete" is required in delta responses? Defaults to false.
  - getEnableRowVersioning
```
public boolean getEnableRowVersioning()
```
    Return should this provider be enabled for row versioning? Defaults to false. When row versioning is enabled, each table row contains a version number that is incremented by one for each update. All updates apply optimistic concurrency control to check that the pre-update row version matches the version known to the client.
    
    See Also:
    
    EntityValue.entityTag, StorageOptions.rowVersionColumn.
    
    Returns:
    
    Should this provider be enabled for row versioning? Defaults to `false`.
  - getFlattenComplexProperties
```
public boolean getFlattenComplexProperties()
```
    Return should complex properties be flattened into separate columns for database storage? Defaults to false.
    
    Returns:
    
    Should complex properties be flattened into separate columns for database storage? Defaults to false.
  - getGenerateForeignKeyConstraints
```
public boolean getGenerateForeignKeyConstraints()
```
    Return should the provider generate foreign key constraints when it creates database tables? Defaults to false. Foreign key constraints ensure that related rows do in fact exist. Foreign key constraints should not be used for tables with inline isDeleted / lastModified columns (for change tracking).
    
    Returns:
    
    Should the provider generate foreign key constraints when it creates database tables? Defaults to false.
  - getGenerateUniqueConstraints
```
public boolean getGenerateUniqueConstraints()
```
    Return should the provider generate unique constraints when it creates database tables? Defaults to false. Unique constraints ensure the integrity of one-to-one relationships (i.e. that we do not have many related rows). Unique constraints should not be used for tables with inline isDeleted / lastModified columns (for change tracking).
    
    Returns:
    
    Should the provider generate unique constraints when it creates database tables? Defaults to false.
  - getLogExceptions
```
public boolean getLogExceptions()
```
    Return should all database exceptions be logged?
    
    Returns:
    
    Should all database exceptions be logged?
  - getMaintainTrackingColumns
```
public boolean getMaintainTrackingColumns()
```
    Return should this provider maintain delta-tracking columns? Defaults to false. Only applicable if SQLDatabaseProvider.enableChangeTracking is true. By default, a database is assumed to maintain tracking columns itself (e.g. using triggers).
    
    See Also:
    
    StorageOptions.isDeletedColumn, StorageOptions.lastModifiedColumn.
    
    Returns:
    
    Should this provider maintain delta-tracking columns? Defaults to `false`.
  - getMaintainVersionColumns
```
public boolean getMaintainVersionColumns()
```
    Return should this provider maintain the row version column? Defaults to false. Only applicable if SQLDatabaseProvider.enableRowVersioning is true. By default, a database is assumed to maintain the row version itself (e.g. using triggers).
    
    See Also:
    
    StorageOptions.rowVersionColumn.
    
    Returns:
    
    Should this provider maintain the row version column? Defaults to `false`.
  - getMetadata
```
public CsdlDocument getMetadata()
```
    Return service metadata.
    
    See Also:
    
    SQLDatabaseProvider.loadMetadata.
    
    Specified by:
    
    getMetadata in interface DataServiceProvider
    
    Returns:
    
    Service metadata.
  - getOldestTransactionForAllDatabases
```
public boolean getOldestTransactionForAllDatabases()
```
    Return when determining the start time of the oldest active database transaction for change tracking queries, should the oldest active transaction time for all databases be used? Defaults to false, so that only the current database (or current schema, if applicable) is considered.
    
    Returns:
    
    When determining the start time of the oldest active database transaction for change tracking queries, should the oldest active transaction time for all databases be used?
  - getRetainDeletionsFor
```
public DayTimeDuration getRetainDeletionsFor()
```
    Return if change tracking is enabled, how long should logically deleted rows be retained to support subsequent delta queries? Defaults to 50 days.
    
    See Also:
    
    SQLDatabaseProvider.enableChangeTracking, SQLDatabaseProvider.purgeExpiredDeletions.
    
    Returns:
    
    If change tracking is enabled, how long should logically deleted rows be retained to support subsequent delta queries? Defaults to 50 days.
  - getSelectAfterCreate
```
public boolean getSelectAfterCreate()
```
    Return should entities be reselected after SQLDatabaseProvider.createEntity (SQL insert)? Defaults to true. This ensures that database-generated column values will be available in the entity parameter. Setting this property to false will result in better createEntity performance, but database-generated values will not be available in the entity parameter. Database-generated primary keys (see SQLDatabaseProvider.autoGenerateKeys) will still be available without setting selectAfterCreate as they are obtained without reselecting the entity. Note: if SQLDatabaseProvider.enableRowVersioning is true and SQLDatabaseProvider.maintainVersionColumns is false, then entities will be automatically reselected after SQLDatabaseProvider.createEntity even if selectAfterCreate is false.
    
    Returns:
    
    Should entities be reselected after SQLDatabaseProvider.createEntity (SQL insert)? Defaults to true. This ensures that database-generated column values will be available in the entity parameter.
  - getSelectAfterUpdate
```
public boolean getSelectAfterUpdate()
```
    Return should entities be reselected after SQLDatabaseProvider.updateEntity (SQL update)? Defaults to true. This ensures that database-generated column values will be available in the entity parameter. Setting this property to false will result in better SQLDatabaseProvider.updateEntity performance, but database-generated values will not be available in the entity parameter. Database-generated primary keys (see SQLDatabaseProvider.autoGenerateKeys) will still be available without setting selectAfterUpdate as they are obtained without reselecting the entity. Note: if SQLDatabaseProvider.enableRowVersioning is true and SQLDatabaseProvider.maintainVersionColumns is false, then entities will be automatically reselected after SQLDatabaseProvider.createEntity even if selectAfterUpdate is false.
    
    Returns:
    
    Should entities be reselected after SQLDatabaseProvider.updateEntity (SQL update)? Defaults to true. This ensures that database-generated column values will be available in the entity parameter.
  - getServiceName
```
public java.lang.String getServiceName()
```
    Return service name.
    
    Specified by:
    
    getServiceName in interface DataServiceProvider
    
    Returns:
    
    Service name.
  - getStatementBatchSize
```
public int getStatementBatchSize()
```
    Return batch size to be used for statement batching with this provider. Defaults to 100.
    
    Returns:
    
    Batch size to be used for statement batching with this provider. Defaults to 100.
  - getStorageOptions
```
public StorageOptions getStorageOptions()
```
    Return options for database storage.
    
    Returns:
    
    Options for database storage.
  - getSupportsMultitenancy
```
public boolean getSupportsMultitenancy()
```
    Return is this provider multi-tenant-aware? Defaults to false.
    
    See Also:
    
    SQLDatabaseProvider.threadLocalTenant, SQLDatabaseProvider.schemaExistsForTenant, SQLDatabaseProvider.createSchemaForTenant, SQLDatabaseProvider.deleteSchemaForTenant.
    
    Returns:
    
    Is this provider multi-tenant-aware? Defaults to `false`.
  - getThreadLocalTenant
```
public java.lang.String getThreadLocalTenant()
```
    Return (nullable) ID of the current thread's tenant, if applicable.
    
    Returns:
    
    (nullable) ID of the current thread's tenant, if applicable.
  - getTraceRequests
```
public boolean getTraceRequests()
```
    Return should all requests for this SQL database service be traced? Defaults to false.
    
    Returns:
    
    Should all requests for this SQL database service be traced? Defaults to false.
  - getTraceWithData
```
public boolean getTraceWithData()
```
    Return if SQLDatabaseProvider.traceRequests is also true, should all requests for this SQL database be traced with data? Defaults to false. Note that care must be taken when enabling tracing with data, as the resulting log files may contain sensitive information. On the other hand, tracing with data may sometimes be invaluable for troubleshooting purposes.
    
    Returns:
    
    If SQLDatabaseProvider.traceRequests is also true, should all requests for this SQL database be traced with data? Defaults to false.
  - getUseClientProvidedKeys
```
public boolean getUseClientProvidedKeys()
```
    Return should SQLDatabaseProvider.createEntity use client-provided keys (when available), in preference to server-generated keys? Defaults to false.
    
    Returns:
    
    Should SQLDatabaseProvider.createEntity use client-provided keys (when available), in preference to server-generated keys? Defaults to false.
  - hasMetadata
```
public boolean hasMetadata()
```
    Return has service metadata been loaded.
    
    See Also:
    
    SQLDatabaseProvider.loadMetadata.
    
    Specified by:
    
    hasMetadata in interface DataServiceProvider
    
    Returns:
    
    Has service metadata been loaded.
  - isCacheDatabase
```
public boolean isCacheDatabase()
```
    Return is this database a cache (staging) database for a backend system? Defaults to false.
    
    Returns:
    
    Is this database a cache (staging) database for a backend system? Defaults to false.
  - isMetricProvider
```
public boolean isMetricProvider()
```
    Return is this provider used for data metrics?
    
    Returns:
    
    Is this provider used for data metrics?
  - loadMetadata
```
public void loadMetadata(HttpHeaders headers,
                         RequestOptions options)
```
    Load service metadata (if not already loaded).
    
    See Also:
    
    SQLDatabaseProvider.metadata, SQLDatabaseProvider.hasMetadata.
    
    Specified by:
    
    loadMetadata in interface DataServiceProvider
    
    Parameters:
    
    headers - Optional request-specific headers.
    
    options - Optional request-specific options.
  - metadataText
```
public java.lang.String metadataText(int format)
```
    Return metadata document text of the service.
    
    See Also:
    
    DataFormat.
    
    Specified by:
    
    metadataText in interface DataServiceProvider
    
    Parameters:
    
    format - Metadata format. Only XML is presently supported.
    
    Returns:
    
    Metadata document text of the service.
  - openSchema
```
public void openSchema()
```
    Open the database schema for this provider. Ensures that database connectivity is available and that (in principle) database operations can proceed.
  - openSchemaWithRetryLoop
```
public void openSchemaWithRetryLoop()
```
    Open the database schema for this provider. Ensures that database connectivity is available and that (in principle) database operations can proceed. If opening fails, then retry (potentially forever) with a one minute delay between retries.
  - pingServer
```
public void pingServer(HttpHeaders headers,
                       RequestOptions options)
```
    Ping the server.
    
    Specified by:
    
    pingServer in interface DataServiceProvider
    
    Parameters:
    
    headers - Optional request-specific headers.
    
    options - Optional request-specific options.
  - prepareData
```
public void prepareData(com.sap.cloud.server.odata.core.Action0 work)
```
    Execute work within a transaction.
    
    Parameters:
    
    work - Work to be executed within a transaction.
  - prepareDataForTenant
```
public void prepareDataForTenant(com.sap.cloud.server.odata.core.Action0 work)
```
    Execute a transaction to prepare data for the current tenant.
    
    Parameters:
    
    work - Function to do the transaction work.
  - processBatch
```
public void processBatch(RequestBatch batch,
                         HttpHeaders headers,
                         RequestOptions options)
```
    Execute a request batch in the target system.
    
    Specified by:
    
    processBatch in interface DataServiceProvider
    
    Parameters:
    
    batch - The request batch.
    
    headers - Request-specific headers.
    
    options - Request-specific options.
  - purgeAllDeletions
```
public void purgeAllDeletions()
```
    Purge any logically-deleted rows (rows that were marked as deleted for change tracking), even those whose time of deletion does not exceed the SQLDatabaseProvider.retainDeletionsFor period.
  - purgeDeletionsForTenant
```
public void purgeDeletionsForTenant()
```
    Purge any logically-deleted rows for the current tenant (rows that were marked as deleted for change tracking), even those whose time of deletion does not exceed the SQLDatabaseProvider.retainDeletionsFor period.
  - purgeExpiredDeletions
```
public void purgeExpiredDeletions()
```
    Purge any logically-deleted rows (rows that were marked as deleted for change tracking) whose time of deletion exceeds the SQLDatabaseProvider.retainDeletionsFor period.
  - queryContext
```
public DataContext queryContext(int version)
```
    Return a data context for parsing a data query.
    
    See Also:
    
    DataVersion.
    
    Specified by:
    
    queryContext in interface DataServiceProvider
    
    Parameters:
    
    version - Data version.
    
    Returns:
    
    A data context for parsing a data query.
  - rollback
```
public void rollback()
```
    Rollback the current transaction. If the current transaction is a nested transaction, then decrease the nesting level, and mark the outermost (non-nested) transaction for eventual rollback.
    
    Specified by:
    
    rollback in interface DataServiceProvider
  - schemaExists
```
public boolean schemaExists()
```
    Return true if the database schema artifacts (e.g. tables) exist for this provider.
    
    Returns:
    
    true if the database schema artifacts (e.g. tables) exist for this provider.
  - schemaExistsForTenant
```
public boolean schemaExistsForTenant()
```
    Return true if the database artifacts (e.g. tables) exist in this database for the current tenant?
    
    See Also:
    
    SQLDatabaseProvider.supportsMultitenancy.
    
    Returns:
    
    `true` if the database artifacts (e.g. tables) exist in this database for the current tenant?
  - selectEntity
```
public EntityValue selectEntity(EntityValue entity)
```
    Return newly loaded copy of entity with all structural properties selected.
    
    Parameters:
    
    entity - Entity value.
    
    Returns:
    
    Newly loaded copy of entity with all structural properties selected.
  - serviceDocument
```
public java.lang.String serviceDocument(int format)
```
    Return the service document, in XML or JSON format.
    
    See Also:
    
    DataFormat.
    
    Specified by:
    
    serviceDocument in interface DataServiceProvider
    
    Parameters:
    
    format - Data format (XML or JSON).
    
    Returns:
    
    The service document, in XML or JSON format.
  - setAllowNonUtcTimeZone
```
public void setAllowNonUtcTimeZone(boolean value)
```
    Set can the database clock be configured with a time zone other than UTC? Defaults to false.
    
    Parameters:
    
    value - Can the database clock be configured with a time zone other than UTC? Defaults to false.
  - setAutoBindEntities
```
public void setAutoBindEntities(boolean value)
```
    Set should this provider automatically bind entities in SQLDatabaseProvider.createEntity or SQLDatabaseProvider.updateEntity, if bound entities are provided by the client. Defaults to true.
    
    Parameters:
    
    value - Should this provider automatically bind entities in SQLDatabaseProvider.createEntity or SQLDatabaseProvider.updateEntity, if bound entities are provided by the client. Defaults to true.
  - setAutoCreateChildren
```
public void setAutoCreateChildren(boolean value)
```
    Set should this provider automatically create children in SQLDatabaseProvider.createEntity ("deep insert" calls), if nested children are provided by the client. Defaults to true.
    
    Parameters:
    
    value - Should this provider automatically create children in SQLDatabaseProvider.createEntity ("deep insert" calls), if nested children are provided by the client. Defaults to true.
  - setAutoCreateParents
```
public void setAutoCreateParents(boolean value)
```
    Set should this provider automatically create parents in SQLDatabaseProvider.createEntity ("deep insert" calls), if nested parents are provided by the client. Defaults to true.
    
    Parameters:
    
    value - Should this provider automatically create parents in SQLDatabaseProvider.createEntity ("deep insert" calls), if nested parents are provided by the client. Defaults to true.
  - setAutoDeleteChildren
```
public void setAutoDeleteChildren(boolean value)
```
    Set should this provider automatically delete children in SQLDatabaseProvider.deleteEntity ("on delete" actions), if specified with OnDelete in the service metadata. Defaults to true.
    
    Parameters:
    
    value - Should this provider automatically delete children in SQLDatabaseProvider.deleteEntity ("on delete" actions), if specified with OnDelete in the service metadata. Defaults to true.
  - setAutoExpandItems
```
public void setAutoExpandItems(boolean value)
```
    Set should this provider automatically expand itemns in SQLDatabaseProvider.executeQuery, if requested in the client's query. Defaults to true.
    
    Parameters:
    
    value - Should this provider automatically expand itemns in SQLDatabaseProvider.executeQuery, if requested in the client's query. Defaults to true.
  - setAutoGenerateKeys
```
public void setAutoGenerateKeys(boolean value)
```
    Set should this provider automatically generate primary keys? Defaults to true. If the provider doesn't generate keys, then the client will have to provide them.
    
    See Also:
    
    SQLDatabaseProvider.useClientProvidedKeys.
    
    Parameters:
    
    value - Should this provider automatically generate primary keys? Defaults to `true`.
  - setAutoUnbindEntities
```
public void setAutoUnbindEntities(boolean value)
```
    Set should this provider automatically unbind entities in SQLDatabaseProvider.createEntity or SQLDatabaseProvider.updateEntity, if unbound entities are provided by the client. Defaults to true.
    
    Parameters:
    
    value - Should this provider automatically unbind entities in SQLDatabaseProvider.createEntity or SQLDatabaseProvider.updateEntity, if unbound entities are provided by the client. Defaults to true.
  - setCacheDatabase
```
public void setCacheDatabase(boolean value)
```
    Set is this database a cache (staging) database for a backend system? Defaults to false.
    
    Parameters:
    
    value - Is this database a cache (staging) database for a backend system? Defaults to false.
  - setCacheOldestTransactionForSeconds
```
public void setCacheOldestTransactionForSeconds(int value)
```
    Set when determining the start time of the oldest active database transaction for change tracking queries, how long can a cached transaction time be used for? Defaults to 5. Setting this value too high can result in clients downloading the same changes repeatedly (if the interval between client downloads is smaller than the caching interval). Setting this value too low can result in frequent database interactions to determine the start time of the oldest active transaction. Setting this value to zero (or negative) will disable caching of the start time of the oldest active transaction.
    
    Parameters:
    
    value - When determining the start time of the oldest active database transaction for change tracking queries, how long can a cached transaction time be used for? Defaults to 5.
  - setCanModifySchema
```
public void setCanModifySchema(boolean value)
```
    Set is this provider permitted to modify the database schema, e.g. by adding required tables? Defaults to true. If not enabled, then schema changes will need to be managed by the database administrator.
    
    Parameters:
    
    value - Is this provider permitted to modify the database schema, e.g. by adding required tables? Defaults to true.
  - setClientExpiryInterval
```
public void setClientExpiryInterval(DayTimeDuration value)
```
    Set if SQLDatabaseProvider.startClientExpiryThread is called, how often should it perform cleanup activity? Defaults to one hour. Intervals of less than one minute will be treated as one minute.
    
    Parameters:
    
    value - If SQLDatabaseProvider.startClientExpiryThread is called, how often should it perform cleanup activity? Defaults to one hour.
  - setDebugConnections
```
public void setDebugConnections(boolean value)
```
    Set should all connections (opening/closing) to this SQL database service be logged? Defaults to false.
    
    Parameters:
    
    value - Should all connections (opening/closing) to this SQL database service be logged? Defaults to false.
  - setDeltaCleanupInterval
```
public void setDeltaCleanupInterval(DayTimeDuration value)
```
    Set if SQLDatabaseProvider.startDeltaCleanupThread is called, how often should it perform cleanup activity? Defaults to one hour. Intervals of less than one minute will be treated as one minute.
    
    Parameters:
    
    value - If SQLDatabaseProvider.startDeltaCleanupThread is called, how often should it perform cleanup activity? Defaults to one hour.
  - setDownloadBeforeOldestTransaction
```
public void setDownloadBeforeOldestTransaction(int value)
```
    Set when determining the next "last download" time for delta downloads, how many seconds should it be prior to the start time of the oldest active database transaction? Defaults to 5. It is assumed that if the database server is clustered, the cluster nodes will be time-synchronized to within this interval.
    
    See Also:
    
    Network Time Protocol.
    
    Parameters:
    
    value - When determining the next "last download" time for delta downloads, how many seconds should it be prior to the start time of the oldest active database transaction? Defaults to `5`.
  - setEnableChangeTracking
```
public void setEnableChangeTracking(boolean value)
```
    Set should this provider be enabled for change tracking? Defaults to false.
    
    See Also:
    
    SQLDatabaseProvider.maintainTrackingColumns, EntitySet.trackChanges, StorageOptions.isDeletedColumn, StorageOptions.lastModifiedColumn.
    
    Parameters:
    
    value - Should this provider be enabled for change tracking? Defaults to `false`.
  - setEnableKeyTracking
```
public void setEnableKeyTracking(boolean value)
```
    Set should this provider use key tracking for determining when "delete" is required in delta responses? Defaults to false.
    
    Parameters:
    
    value - Should this provider use key tracking for determining when "delete" is required in delta responses? Defaults to false.
  - setEnableRowVersioning
```
public void setEnableRowVersioning(boolean value)
```
    Set should this provider be enabled for row versioning? Defaults to false. When row versioning is enabled, each table row contains a version number that is incremented by one for each update. All updates apply optimistic concurrency control to check that the pre-update row version matches the version known to the client.
    
    See Also:
    
    EntityValue.entityTag, StorageOptions.rowVersionColumn.
    
    Parameters:
    
    value - Should this provider be enabled for row versioning? Defaults to `false`.
  - setFlattenComplexProperties
```
public void setFlattenComplexProperties(boolean value)
```
    Set should complex properties be flattened into separate columns for database storage? Defaults to false.
    
    Parameters:
    
    value - Should complex properties be flattened into separate columns for database storage? Defaults to false.
  - setGenerateForeignKeyConstraints
```
public void setGenerateForeignKeyConstraints(boolean value)
```
    Set should the provider generate foreign key constraints when it creates database tables? Defaults to false. Foreign key constraints ensure that related rows do in fact exist. Foreign key constraints should not be used for tables with inline isDeleted / lastModified columns (for change tracking).
    
    Parameters:
    
    value - Should the provider generate foreign key constraints when it creates database tables? Defaults to false.
  - setGenerateUniqueConstraints
```
public void setGenerateUniqueConstraints(boolean value)
```
    Set should the provider generate unique constraints when it creates database tables? Defaults to false. Unique constraints ensure the integrity of one-to-one relationships (i.e. that we do not have many related rows). Unique constraints should not be used for tables with inline isDeleted / lastModified columns (for change tracking).
    
    Parameters:
    
    value - Should the provider generate unique constraints when it creates database tables? Defaults to false.
  - setInitialDataLoader
```
public void setInitialDataLoader(com.sap.cloud.server.odata.core.Action0 loader)
```
    Register a callback handler which will be used for loading initial data into the database.
    
    Parameters:
    
    loader - Initial data Loader.
  - setLogExceptions
```
public void setLogExceptions(boolean value)
```
    Set should all database exceptions be logged?
    
    Parameters:
    
    value - Should all database exceptions be logged?
  - setMaintainTrackingColumns
```
public void setMaintainTrackingColumns(boolean value)
```
    Set should this provider maintain delta-tracking columns? Defaults to false. Only applicable if SQLDatabaseProvider.enableChangeTracking is true. By default, a database is assumed to maintain tracking columns itself (e.g. using triggers).
    
    See Also:
    
    StorageOptions.isDeletedColumn, StorageOptions.lastModifiedColumn.
    
    Parameters:
    
    value - Should this provider maintain delta-tracking columns? Defaults to `false`.
  - setMaintainVersionColumns
```
public void setMaintainVersionColumns(boolean value)
```
    Set should this provider maintain the row version column? Defaults to false. Only applicable if SQLDatabaseProvider.enableRowVersioning is true. By default, a database is assumed to maintain the row version itself (e.g. using triggers).
    
    See Also:
    
    StorageOptions.rowVersionColumn.
    
    Parameters:
    
    value - Should this provider maintain the row version column? Defaults to `false`.
  - setMetadata
```
public void setMetadata(CsdlDocument value)
```
    Set service metadata.
    
    See Also:
    
    SQLDatabaseProvider.loadMetadata.
    
    Specified by:
    
    setMetadata in interface DataServiceProvider
    
    Parameters:
    
    value - Service metadata.
  - setMetricProvider
```
public void setMetricProvider(boolean value)
```
    Set is this provider used for data metrics?
    
    Parameters:
    
    value - Is this provider used for data metrics?
  - setOldestTransactionForAllDatabases
```
public void setOldestTransactionForAllDatabases(boolean value)
```
    Set when determining the start time of the oldest active database transaction for change tracking queries, should the oldest active transaction time for all databases be used? Defaults to false, so that only the current database (or current schema, if applicable) is considered.
    
    Parameters:
    
    value - When determining the start time of the oldest active database transaction for change tracking queries, should the oldest active transaction time for all databases be used?
  - setRetainDeletionsFor
```
public void setRetainDeletionsFor(DayTimeDuration value)
```
    Set if change tracking is enabled, how long should logically deleted rows be retained to support subsequent delta queries? Defaults to 50 days.
    
    See Also:
    
    SQLDatabaseProvider.enableChangeTracking, SQLDatabaseProvider.purgeExpiredDeletions.
    
    Parameters:
    
    value - If change tracking is enabled, how long should logically deleted rows be retained to support subsequent delta queries? Defaults to 50 days.
  - setSelectAfterCreate
```
public void setSelectAfterCreate(boolean value)
```
    Set should entities be reselected after SQLDatabaseProvider.createEntity (SQL insert)? Defaults to true. This ensures that database-generated column values will be available in the entity parameter. Setting this property to false will result in better createEntity performance, but database-generated values will not be available in the entity parameter. Database-generated primary keys (see SQLDatabaseProvider.autoGenerateKeys) will still be available without setting selectAfterCreate as they are obtained without reselecting the entity. Note: if SQLDatabaseProvider.enableRowVersioning is true and SQLDatabaseProvider.maintainVersionColumns is false, then entities will be automatically reselected after SQLDatabaseProvider.createEntity even if selectAfterCreate is false.
    
    Parameters:
    
    value - Should entities be reselected after SQLDatabaseProvider.createEntity (SQL insert)? Defaults to true. This ensures that database-generated column values will be available in the entity parameter.
  - setSelectAfterUpdate
```
public void setSelectAfterUpdate(boolean value)
```
    Set should entities be reselected after SQLDatabaseProvider.updateEntity (SQL update)? Defaults to true. This ensures that database-generated column values will be available in the entity parameter. Setting this property to false will result in better SQLDatabaseProvider.updateEntity performance, but database-generated values will not be available in the entity parameter. Database-generated primary keys (see SQLDatabaseProvider.autoGenerateKeys) will still be available without setting selectAfterUpdate as they are obtained without reselecting the entity. Note: if SQLDatabaseProvider.enableRowVersioning is true and SQLDatabaseProvider.maintainVersionColumns is false, then entities will be automatically reselected after SQLDatabaseProvider.createEntity even if selectAfterUpdate is false.
    
    Parameters:
    
    value - Should entities be reselected after SQLDatabaseProvider.updateEntity (SQL update)? Defaults to true. This ensures that database-generated column values will be available in the entity parameter.
  - setStatementBatchSize
```
public void setStatementBatchSize(int value)
```
    Set batch size to be used for statement batching with this provider. Defaults to 100.
    
    Parameters:
    
    value - Batch size to be used for statement batching with this provider. Defaults to 100.
  - setSupportsMultitenancy
```
public void setSupportsMultitenancy(boolean value)
```
    Set is this provider multi-tenant-aware? Defaults to false.
    
    See Also:
    
    SQLDatabaseProvider.threadLocalTenant, SQLDatabaseProvider.schemaExistsForTenant, SQLDatabaseProvider.createSchemaForTenant, SQLDatabaseProvider.deleteSchemaForTenant.
    
    Parameters:
    
    value - Is this provider multi-tenant-aware? Defaults to `false`.
  - setThreadLocalTenant
```
public void setThreadLocalTenant(java.lang.String value)
```
    Set ID of the current thread's tenant, if applicable.
    
    Parameters:
    
    value - ID of the current thread's tenant, if applicable.
  - setTraceRequests
```
public void setTraceRequests(boolean value)
```
    Set should all requests for this SQL database service be traced? Defaults to false.
    
    Parameters:
    
    value - Should all requests for this SQL database service be traced? Defaults to false.
  - setTraceWithData
```
public void setTraceWithData(boolean value)
```
    Set if SQLDatabaseProvider.traceRequests is also true, should all requests for this SQL database be traced with data? Defaults to false. Note that care must be taken when enabling tracing with data, as the resulting log files may contain sensitive information. On the other hand, tracing with data may sometimes be invaluable for troubleshooting purposes.
    
    Parameters:
    
    value - If SQLDatabaseProvider.traceRequests is also true, should all requests for this SQL database be traced with data? Defaults to false.
  - setUseClientProvidedKeys
```
public void setUseClientProvidedKeys(boolean value)
```
    Set should SQLDatabaseProvider.createEntity use client-provided keys (when available), in preference to server-generated keys? Defaults to false.
    
    Parameters:
    
    value - Should SQLDatabaseProvider.createEntity use client-provided keys (when available), in preference to server-generated keys? Defaults to false.
  - startClientExpiryThread
```
public void startClientExpiryThread(com.sap.cloud.server.odata.core.ThreadShutdown shutdown)
```
    Start a thread which will periodically delete expired clients and related client-specific data.
    
    Parameters:
    
    shutdown - Signal for shutting down the started thread.
  - startDeltaCleanupThread
```
public void startDeltaCleanupThread(com.sap.cloud.server.odata.core.ThreadShutdown shutdown)
```
    Start a thread which will periodically purge expired deletions.
    
    See Also:
    
    SQLDatabaseProvider.enableChangeTracking, SQLDatabaseProvider.purgeExpiredDeletions, SQLDatabaseProvider.deltaCleanupInterval.
    
    Parameters:
    
    shutdown - Signal for shutting down the started thread.
  - storedProcedure
```
public DataMethod storedProcedure(java.lang.String name)
```
    Return a data method for use in the execution of a database stored procedure.
    
    See Also:
    
    SQLDatabaseProvider.executeMethod.
    
    Parameters:
    
    name - Stored procedure name.
    
    Returns:
    
    a data method for use in the execution of a database stored procedure.
  - transaction
```
public void transaction(com.sap.cloud.server.odata.core.Action0 work)
```
    Perform some work within a database transaction. If a transaction is already active, then the work will be performed within a nested transaction.
    
    Parameters:
    
    work - Work to be executed within a transaction.
  - unbindEntities
```
public void unbindEntities(EntityValue entity)
```
    See unbindEntities(EntityValue, Property).
    
    Parameters:
    
    entity - Entity parameter.
  - unbindEntities
```
public void unbindEntities(EntityValue entity,
                           Property bindingProperty)
```
    This function may be used in the implementation of entity binding calls, e.g. by EntityValue.unbindEntity. It relies on the existence of appropriate referential constraints in the service metadata.
    
    Parameters:
    
    entity - Source entity, which may contain inline bindings for the binding property.
    
    bindingProperty - (nullable) Binding property. If null, then all of the source's navigation properties are considered.
  - unloadMetadata
```
public void unloadMetadata()
```
    Unload service metadata (if previously loaded).
    
    See Also:
    
    SQLDatabaseProvider.metadata, SQLDatabaseProvider.hasMetadata.
    
    Specified by:
    
    unloadMetadata in interface DataServiceProvider
  - updateClientExpiry
```
public void updateClientExpiry(EntityValue registration)
```
    Arrange for client expiry after a client registration has been created.
    
    See Also:
    
    SQLDatabaseProvider.retainDeletionsFor, which also determines how long inactive client registrations will be retained.
    
    Parameters:
    
    registration - Client registration.
  - updateEntity
```
public void updateEntity(EntityValue entity)
```
    See updateEntity(EntityValue, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
  - updateEntity
```
public void updateEntity(EntityValue entity,
                         HttpHeaders headers)
```
    See updateEntity(EntityValue, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
    
    headers - Headers parameter.
  - updateEntity
```
public void updateEntity(EntityValue entity,
                         HttpHeaders headers,
                         RequestOptions options)
```
    Update an entity in the target system.
    
    Specified by:
    
    updateEntity in interface DataServiceProvider
    
    Parameters:
    
    entity - Entity to be updated.
    
    headers - Request-specific headers.
    
    options - Request-specific options.
  - updateEntityReturningError
```
public java.lang.RuntimeException updateEntityReturningError(EntityValue entity)
```
    See updateEntityReturningError(EntityValue, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
    
    Returns:
    
    (see linked method).
  - updateEntityReturningError
```
public java.lang.RuntimeException updateEntityReturningError(EntityValue entity,
                                                             HttpHeaders headers)
```
    See updateEntityReturningError(EntityValue, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
    
    headers - Headers parameter.
    
    Returns:
    
    (see linked method).
  - updateEntityReturningError
```
public java.lang.RuntimeException updateEntityReturningError(EntityValue entity,
                                                             HttpHeaders headers,
                                                             RequestOptions options)
```
    Call SQLDatabaseProvider.createEntity but catch any excepion it throws (non-logged) and return it.
    
    Parameters:
    
    entity - Entity to be updated.
    
    headers - Request-specific headers.
    
    options - Request-specific options.
    
    Returns:
    
    (nullable) Caught error, if any. (The error will not be logged).
  - updateLink
```
public void updateLink(EntityValue from,
                       Property property,
                       EntityValue to)
```
    See updateLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).
    
    Parameters:
    
    from - From parameter.
    
    property - Property parameter.
    
    to - To parameter.
  - updateLink
```
public void updateLink(EntityValue from,
                       Property property,
                       EntityValue to,
                       HttpHeaders headers)
```
    See updateLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).
    
    Parameters:
    
    from - From parameter.
    
    property - Property parameter.
    
    to - To parameter.
    
    headers - Headers parameter.
  - updateLink
```
public void updateLink(EntityValue from,
                       Property property,
                       EntityValue to,
                       HttpHeaders headers,
                       RequestOptions options)
```
    Update a link from a source entity to a target entity.
    
    Specified by:
    
    updateLink in interface DataServiceProvider
    
    Parameters:
    
    from - Source entity for the link to be updated.
    
    property - Source navigation property for the link to be updated. This must be a one-to-one navigation property.
    
    to - Target entity for the link to be updated.
    
    headers - Request-specific headers.
    
    options - Request-specific options.
  - updateLinkUsingForeignKeys
```
public void updateLinkUsingForeignKeys(EntityValue source,
                                       Property sourceProperty,
                                       EntityValue target)
```
    Default implementation of 'updateLink' using foreign keys from referential constraints in service metadata.
    
    Parameters:
    
    source - Source entity for the link to be created.
    
    sourceProperty - Source navigation property for the link to be created. This may be a one-to-one or one-to-many navigation property.
    
    target - Target entity for the link to be created.
  - uploadMedia
```
public void uploadMedia(EntityValue entity,
                        StreamBase content)
```
    See uploadMedia(EntityValue, StreamBase, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
    
    content - Content parameter.
  - uploadMedia
```
public void uploadMedia(EntityValue entity,
                        StreamBase content,
                        HttpHeaders headers)
```
    See uploadMedia(EntityValue, StreamBase, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
    
    content - Content parameter.
    
    headers - Headers parameter.
  - uploadMedia
```
public void uploadMedia(EntityValue entity,
                        StreamBase content,
                        HttpHeaders headers,
                        RequestOptions options)
```
    Upload content for a media entity to the target system Caution: Having too many threads simultaneously uploading streams may result in out-of-memory conditions on memory-constrained devices. Note: this function cannot be used to create a media entity. See DataService.createMedia.
    
    Specified by:
    
    uploadMedia in interface DataServiceProvider
    
    Parameters:
    
    entity - Entity whose content is to be uploaded.
    
    content - Upload stream content. Will be closed before this function returns.
    
    headers - Request-specific headers.
    
    options - Request-specific options.
  - uploadStream
```
public void uploadStream(EntityValue entity,
                         StreamLink link,
                         StreamBase content)
```
    See uploadStream(EntityValue, StreamLink, StreamBase, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
    
    link - Link parameter.
    
    content - Content parameter.
  - uploadStream
```
public void uploadStream(EntityValue entity,
                         StreamLink link,
                         StreamBase content,
                         HttpHeaders headers)
```
    See uploadStream(EntityValue, StreamLink, StreamBase, HttpHeaders, RequestOptions).
    
    Parameters:
    
    entity - Entity parameter.
    
    link - Link parameter.
    
    content - Content parameter.
    
    headers - Headers parameter.
  - uploadStream
```
public void uploadStream(EntityValue entity,
                         StreamLink link,
                         StreamBase content,
                         HttpHeaders headers,
                         RequestOptions options)
```
    Upload content for a stream property to the target system. Caution: Having too many threads simultaneously uploading streams may result in out-of-memory conditions on memory-constrained devices.
    
    See Also:
    
    Property.getStreamLink.
    
    Specified by:
    
    uploadStream in interface DataServiceProvider
    
    Parameters:
    
    entity - Entity containing the stream property whose content is to be uploaded.
    
    link - Stream link for the stream to be uploaded.
    
    content - Upload stream content. Will be closed before this function returns.
    
    headers - Request-specific headers.
    
    options - Request-specific options.

Class SQLDatabaseProvider

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SQLDatabaseProvider

SQLDatabaseProvider

Method Detail

withDataSource

applyChanges

applyChanges

applyChanges

beginTransaction

bindEntities

bindEntities

bindEntities

bindEntities

bindEntitiesAfterCreate

bindEntitiesAfterCreate

bindEntitiesAfterUpdate

bindEntitiesAfterUpdate

closeAllConnections

closeConnection

commit

createChildren

createChildren

createClientExpiry

createEntity

createEntity

createEntity

createEntityReturningError

createEntityReturningError

createEntityReturningError

createLink

createLink

createLink

createLinkUsingForeignKeys

createMedia

createMedia

createMedia

createParents

createParents

createSchema

createSchemaForTenant

createSchemaWithRetryLoop

currentLDT

currentUTC

deleteByQuery

deleteByQuery

deleteByQuery

deleteChildren

deleteChildren

deleteEntity

deleteEntity

deleteEntity

deleteEntityReturningError

deleteEntityReturningError

deleteEntityReturningError

deleteLink

deleteLink

deleteLink

deleteLinkUsingForeignKeys

deleteSchema

deleteSchemaForTenant

deleteStream

deleteStream

deleteStream

downloadMedia

downloadMedia

downloadMedia

downloadStream

downloadStream

downloadStream

entityContext

executeBatch

executeMethod

executeMethod

executeMethod

executeQuery

executeQuery