oracle.soda

Interface OracleCollectionAdmin

public interface OracleCollectionAdmin

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

An OracleCollectionAdmin object is associated with a particular OracleCollection object.

Method Summary

Modifier and Type	Method and Description
void	createIndex(OracleDocument indexSpecification) Create an index using an index specification (expressed in JSON).
void	createJsonSearchIndex(java.lang.String indexName) Turns on Json Search Index.
void	drop() Drops the collection.
void	dropIndex(java.lang.String indexName) Drops the named index.
void	dropIndex(java.lang.String indexName, boolean force) Drops the named index.
OracleDocument	getDataGuide() Returns a JSON data guide for the collection.
OracleDocument	getMetadata() Returns collection metadata expressed in JSON.
java.lang.String	getName() Gets the collection's name.
boolean	isHeterogeneous() Indicates whether the collection can store non-JSON data.
boolean	isReadOnly() Indicates whether the collection is read-only.
void	truncate() Deletes all documents in the collection.

Method Detail

getName

java.lang.String getName()

Gets the collection's name.

Returns:

collection name as a String

drop

void drop()
   throws OracleException

Drops the collection.

Throws:

OracleException - if an error occurs while dropping the collection

truncate

void truncate()
       throws OracleException

Deletes all documents in the collection.

Throws:

OracleException - if an error occurs while truncating the collection

dropIndex

void dropIndex(java.lang.String indexName)
        throws OracleException

Drops the named index.

Parameters:

indexName - name of the index to drop

Throws:

OracleException - if an error occurs while dropping the index

dropIndex

void dropIndex(java.lang.String indexName,
               boolean force)
        throws OracleException

Drops the named index.

Parameters:

indexName - name of the index to drop

force - force index drop. Can only be used with json search or spatial indexes.

Throws:

OracleException - if an error occurs while dropping the index

createIndex

void createIndex(OracleDocument indexSpecification)
          throws OracleException

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

Parameters:

indexSpecification - an index specification. Cannot be null

Throws:

OracleException - if (1) the index specification is null, or (2) an error occurs while dropping the index

createJsonSearchIndex

void createJsonSearchIndex(java.lang.String indexName)
                    throws OracleException

Turns on Json Search Index.

Parameters:

indexName - name of the index. Cannot be null

Throws:

OracleException - if an error occurs while creating the index

isHeterogeneous

boolean isHeterogeneous()

Indicates whether the collection can store non-JSON data.

Returns:

true if the collection can store non-JSON data; false otherwise

isReadOnly

boolean isReadOnly()

Indicates whether the collection is read-only.

Returns:

true if the collection is read-only; false otherwise

getDataGuide

OracleDocument getDataGuide()
                     throws OracleException

Returns a JSON data guide for the collection. Requires 12.2.0.1 and above Oracle Database release.

Returns:

OracleDocument representing JSON data guide for the collection. null if the data guide is not available.

Throws:

OracleException - if an error occurs while fetching the JSON data guide.

getMetadata

OracleDocument getMetadata()

Returns collection metadata expressed in JSON.

Returns:

collection metadata in JSON