A B C D F G H I K L M N O R S T U V

A

admin() - Method in interface oracle.soda.OracleCollection

Gets an OracleCollectionAdmin object

admin() - Method in interface oracle.soda.OracleDatabase

Gets a OracleDatabaseAdmin object

B

build() - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Builds a JSON object containing the collection metadata.

C

contentColumnCache(boolean) - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Sets the SecureFiles LOB cache setting for the content column.

contentColumnCompress(String) - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Sets the SecureFiles LOB compress setting for the content column.

contentColumnEncrypt(String) - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Sets the SecureFiles LOB encryption setting for the content column.

contentColumnMaxLength(int) - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Sets the maximum length of the content column.

contentColumnName(String) - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Sets the name of the content column.

contentColumnType(String) - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Sets the SQL type of the content column.

contentColumnValidation(String) - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Sets the validation mode for the content column.

count() - Method in interface oracle.soda.OracleOperationBuilder

Counts the number of documents.

createCollection(String) - Method in interface oracle.soda.OracleDatabaseAdmin

Creates a collection with the specified name.

createCollection(String, OracleDocument) - Method in interface oracle.soda.OracleDatabaseAdmin

Creates a collection with the specified name and implementation-specific collection metadata, expressed in JSON.

createDocumentFromByteArray(byte[]) - Method in interface oracle.soda.OracleDocumentFactory

Creates a new document, with the provided byte[] JSON content.

createDocumentFromByteArray(String, byte[]) - Method in interface oracle.soda.OracleDocumentFactory

Creates a new document, with the provided key and byte[] JSON content.

createDocumentFromByteArray(String, byte[], String) - Method in interface oracle.soda.OracleDocumentFactory

Creates a new document, with the provided key, byte[] content, and content type.

createDocumentFromString(String) - Method in interface oracle.soda.OracleDocumentFactory

Creates a new document, with the provided String JSON content.

createDocumentFromString(String, String) - Method in interface oracle.soda.OracleDocumentFactory

Creates a new document, with the provided key and String JSON content.

createDocumentFromString(String, String, String) - Method in interface oracle.soda.OracleDocumentFactory

Creates a new document, with the provided key, String content, and media type.

createIndex(OracleDocument) - Method in interface oracle.soda.OracleCollectionAdmin

Create an index using an index specification (expressed in JSON).

createMetadataBuilder() - Method in class oracle.soda.rdbms.OracleRDBMSClient

Creates an OracleRDBMSMetadataBuilder initialized with default settings.

creationTimeColumnName(String) - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Sets the optional creation time column name.

D

drop() - Method in interface oracle.soda.OracleCollectionAdmin

Drops the collection.

dropIndex(String) - Method in interface oracle.soda.OracleCollectionAdmin

Drops the named index.

F

filter(OracleDocument) - Method in interface oracle.soda.OracleOperationBuilder

Finds documents matching a filter specification (a query-by-example expressed in JSON).

find() - Method in interface oracle.soda.OracleCollection

Returns an OracleOperationBuilder representing an operation that finds all documents in the collection.

findOne(String) - Method in interface oracle.soda.OracleCollection

Finds an OracleDocument matching a key.

G

getCollectionNames() - Method in interface oracle.soda.OracleDatabaseAdmin

Gets a list of the names of all collections in the database.

getCollectionNames(int) - Method in interface oracle.soda.OracleDatabaseAdmin

Gets a list of the names of collections in the database with a limit on the number returned.

getCollectionNames(int, int) - Method in interface oracle.soda.OracleDatabaseAdmin

Gets a list of the names of collections in the database with a limit on the number returned, starting at a specific offset in the list.

getCollectionNames(int, String) - Method in interface oracle.soda.OracleDatabaseAdmin

Gets a list of the names of collections in the database with a limit on the number returned, starting at the first name greater than or equal to startName.

getConnection() - Method in interface oracle.soda.OracleDatabaseAdmin

Return the JDBC connection backing this database.

getContentAsByteArray() - Method in interface oracle.soda.OracleDocument

Returns the content as a byte array.

getContentAsString() - Method in interface oracle.soda.OracleDocument

Returns the content as a String.

getContentLength() - Method in interface oracle.soda.OracleDocument

Returns the length of content if know.

getCreatedOn() - Method in interface oracle.soda.OracleDocument

Returns the timestamp of creation of this document in ISO format.

getCursor() - Method in interface oracle.soda.OracleOperationBuilder

Returns OracleCursor which is an iterator over result documents.

getDatabase(Connection) - Method in interface oracle.soda.OracleClient

Gets the document collections database.

getDatabase(Connection) - Method in class oracle.soda.rdbms.OracleRDBMSClient

getErrorCode() - Method in exception oracle.soda.OracleException

Returns the error code associated with this exception.

getKey() - Method in interface oracle.soda.OracleDocument

Returns the key.

getLastModified() - Method in interface oracle.soda.OracleDocument

Returns the timestamp of the last modification to this document in ISO format.

getMediaType() - Method in interface oracle.soda.OracleDocument

Returns the media type.

getMetadata() - Method in interface oracle.soda.OracleCollectionAdmin

Returns collection metadata expressed in JSON.

getName() - Method in interface oracle.soda.OracleCollectionAdmin

Gets the collection's name.

getNextException() - Method in exception oracle.soda.OracleException

Returns the next OracleException in the chain or null if none.

getOne() - Method in interface oracle.soda.OracleOperationBuilder

Returns a single document.

getProcessedCount() - Method in exception oracle.soda.OracleBatchException

Number of operations processed before the error occurred.

getVersion() - Method in interface oracle.soda.OracleDocument

Returns a string suitable for use as a version of the document.

H

hasNext() - Method in interface oracle.soda.OracleCursor

Returns true if the next OracleDocument is available.

headerOnly() - Method in interface oracle.soda.OracleOperationBuilder

Specifies that the returned documents should contain only the the following: key, creation-on timestamp (if present in the collection), last-modified timestamp (if present in the collection), version (if present in the collection). The documents' contents will not be returned.

I

insert(OracleDocument) - Method in interface oracle.soda.OracleCollection

Inserts a document into the collection.

insert(Iterator<OracleDocument>) - Method in interface oracle.soda.OracleCollection

Inserts multiple documents into the collection.

insertAndGet(OracleDocument) - Method in interface oracle.soda.OracleCollection

Inserts a document into the collection.

insertAndGet(Iterator<OracleDocument>) - Method in interface oracle.soda.OracleCollection

Inserts multiple documents into the collection.

isHeterogeneous() - Method in interface oracle.soda.OracleCollectionAdmin

Indicates whether the collection can store non-JSON data.

isJSON() - Method in interface oracle.soda.OracleDocument

Returns true is this document has media type "application/json".

isReadOnly() - Method in interface oracle.soda.OracleCollectionAdmin

Indicates whether the collection is read-only.

K

key(String) - Method in interface oracle.soda.OracleOperationBuilder

Finds a document with a specific key.

keyColumnAssignmentMethod(String) - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Sets the key column assignment method.

keyColumnMaxLength(int) - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Sets the maximum size of the key column.

keyColumnName(String) - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Sets the name of the key column.

keyColumnSequenceName(String) - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Sets the sequence name for sequence-based keys.

keyColumnType(String) - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Sets the key column type.

keys(Set<String>) - Method in interface oracle.soda.OracleOperationBuilder

Finds documents with specific keys.

L

lastModifiedColumnIndex(String) - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Sets the last-modified column index name.

lastModifiedColumnName(String) - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Sets the optional last-modified timestamp column name.

limit(int) - Method in interface oracle.soda.OracleOperationBuilder

Specifies an upper limit on the number of results.

M

mediaTypeColumnName(String) - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Sets the media type column name.

N

next() - Method in interface oracle.soda.OracleCursor

Returns the next OracleDocument.

O

openCollection(String) - Method in interface oracle.soda.OracleDatabase

Opens a collection with the specified name.

oracle.soda - package oracle.soda

Contains the core SODA interfaces and classes.

oracle.soda.rdbms - package oracle.soda.rdbms

Contains RDBMS-specific SODA interfaces and classes.

OracleBatchException - Exception in oracle.soda

Represents an exception thrown during a batch write operation.

OracleBatchException(String) - Constructor for exception oracle.soda.OracleBatchException

Constructs an OracleBatchException object with a given message.

OracleBatchException(String, int) - Constructor for exception oracle.soda.OracleBatchException

Constructs an OracleBatchException object with a given message.

OracleBatchException(String, int, int) - Constructor for exception oracle.soda.OracleBatchException

Constructs an OracleBatchException with a given message and an error code.

OracleBatchException(Throwable) - Constructor for exception oracle.soda.OracleBatchException

Constructs an OracleBatchException object with a given cause.

OracleBatchException(Throwable, int) - Constructor for exception oracle.soda.OracleBatchException

Constructs an OracleBatchException object with a given cause.

OracleClient - Interface in oracle.soda

Entry point for SODA (Simple Oracle Document Access).

OracleCollection - Interface in oracle.soda

A collection of documents.

OracleCollectionAdmin - Interface in oracle.soda

Provides DDL and metadata methods for the OracleCollection administration: index creation and destruction, collection deletion (ie "drop"), metadata information about the collection, etc.

OracleCursor - Interface in oracle.soda

Operation result cursor.

OracleDatabase - Interface in oracle.soda

A database of document collections.

OracleDatabaseAdmin - Interface in oracle.soda

Provides DDL and metadata methods for the OracleDatabase administration: collection creation, retrieval of collection names, etc.

OracleDocument - Interface in oracle.soda

Represents a document with (typically) JSON content.

OracleDocumentFactory - Interface in oracle.soda

A factory for creating OracleDocument objects.

OracleException - Exception in oracle.soda

A general exception thrown by various methods of this API.

OracleException(String) - Constructor for exception oracle.soda.OracleException

Constructs an OracleException object with a given message.

OracleException(Throwable) - Constructor for exception oracle.soda.OracleException

Constructs an OracleException with a specified cause (for example, a SQLException or an IOException).

OracleException(Throwable, int) - Constructor for exception oracle.soda.OracleException

Constructs an OracleException with a specified cause (for example, a SQLException or an IOException).

OracleException(String, int) - Constructor for exception oracle.soda.OracleException

Constructs an OracleException with a given message and an error code.

OracleException(String, Throwable, int) - Constructor for exception oracle.soda.OracleException

Constructs an OracleException with a given message, cause, error code, and error prefix.

OracleOperationBuilder - Interface in oracle.soda

An OracleOperationBuilder builds and executes various read and write operations on the OracleCollection, in a chainable manner.

OracleRDBMSClient - Class in oracle.soda.rdbms

Starting point for the RDBMS SODA implementation.

OracleRDBMSClient() - Constructor for class oracle.soda.rdbms.OracleRDBMSClient

OracleRDBMSClient(Properties) - Constructor for class oracle.soda.rdbms.OracleRDBMSClient

The following properties are currently supported:

oracle.soda.sharedMetadataCache - if set to true, the shared cache of collection metadata will be turned on.

OracleRDBMSMetadataBuilder - Interface in oracle.soda.rdbms

Builds JSON collection metadata.

R

readOnly(boolean) - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Sets the read/write policy.

remove() - Method in interface oracle.soda.OracleOperationBuilder

Removes documents.

removeOptionalColumns() - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Removes the optional metadata columns.

replaceOne(OracleDocument) - Method in interface oracle.soda.OracleOperationBuilder

Replaces a document.

replaceOneAndGet(OracleDocument) - Method in interface oracle.soda.OracleOperationBuilder

Replaces a document.

S

save(OracleDocument) - Method in interface oracle.soda.OracleCollection

Saves a document into the collection.

saveAndGet(OracleDocument) - Method in interface oracle.soda.OracleCollection

Saves a document into the collection.

schemaName(String) - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Sets the SQL schema name for the underlying database object.

setNextException(OracleException) - Method in exception oracle.soda.OracleException

Adds an OracleException to the chain of exceptions.

skip(long) - Method in interface oracle.soda.OracleOperationBuilder

Specifies the number of results to skip.

T

tableName(String) - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Sets the SQL table name.

truncate() - Method in interface oracle.soda.OracleCollectionAdmin

Deletes all documents in the collection.

U

UNKNOWN_ERROR_CODE - Static variable in exception oracle.soda.OracleException

V

version(String) - Method in interface oracle.soda.OracleOperationBuilder

Finds a document with a specific version.

versionColumnMethod(String) - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Sets version column method.

versionColumnName(String) - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Sets the version (ETag) column name.

viewName(String) - Method in interface oracle.soda.rdbms.OracleRDBMSMetadataBuilder

Sets the SQL view name.

A B C D F G H I K L M N O R S T U V