Pre-26ai Collection Metadata Components (Reference)

This section only applies to pre-26ai collections. 26ai JSON collection tables and views do not have separate metadata and are not configurable via metadata. While the metadata accessor or *_SODA_COLLECTION views return metadata for these collections, it is simply synthesized on the fly for SODA driver use.

Collection metadata is composed of multiple components, each described in detail below.

Note: The identifiers used for collection metadata components (schema name, table name, view name, database sequence name, and column names) must be valid Oracle quoted identifiers.¹ Some characters and words that are allowed in Oracle quoted identifiers are strongly discouraged. For details, see Oracle Database SQL Language Reference.

• Default Collection Metadata The kind of database and the release compatibility (parameter compatible value) you use determine the collection metadata that is used by default, and which of its field values you can modify for custom metadata.

• Schema

  The collection metadata component that specifies the name of the Oracle Database schema that owns the table or view to which the collection is mapped.

• Table or View

  The collection metadata component that specifies the name of the table or view to which the collection is mapped.

• Key Column Name

  The collection metadata component that specifies the name of the column that stores the document key.

• Key Column Type The collection metadata component that specifies the SQL data type of the column that stores the document key.

• Key Column Max Length The collection metadata component that specifies the maximum length of the key column in bytes. This component applies only to keys of type VARCHAR2.

• Key Column Assignment Method

  The collection metadata component that specifies the method used to assign keys to objects that are inserted into the collection.

• Key Column Path

  The collection metadata component that specifies the top-level document path to the field used as an embedded document key.

• Key Column Sequence Name The collection metadata component that specifies the name of the database sequence that generates keys for documents that are inserted into a collection if the key assignment method is SEQUENCE.

• Content Column Name

  The collection metadata component that specifies the name of the column that stores the database content.

• Content Column Type The collection metadata component that specifies the SQL data type of the column that stores the document content.

• Content Column Format The collection metadata component that specifies the format of the column that stores the document content.

• Content Column Max Length The collection metadata component that specifies the maximum length of the content column in bytes. This component applies only to content of type VARCHAR2.

• Content Column JSON Validation

  The collection metadata component that specifies the syntax to which JavaScript Object Notation (JSON) content must conform—strict or lax.

• Content Column SecureFiles LOB Compression

  The collection metadata component that specifies the SecureFiles LOB compression setting.

• Content Column SecureFiles LOB Cache

  The collection metadata component that specifies the SecureFiles LOB cache setting.

• Content Column SecureFiles LOB Encryption

  The collection metadata component that specifies the SecureFiles LOB encryption setting.

• Version Column Name

  The collection metadata component that specifies the name of the column that stores the document version.

• Version Column Generation Method The collection metadata component that specifies the method used to compute version values for objects when they are inserted into a collection or replaced.

• Last-Modified Time Stamp Column Name The collection metadata component that specifies the name of the column that stores the last-modified time stamp of the document.

• Last-Modified Column Index Name The collection metadata component that specifies the name of the index on the last-modified column.

• Creation Time Stamp Column Name

  The collection metadata component that specifies the name of the column that stores the creation time stamp of the document. This time stamp is generated during the insert, insertAndGet, save, or saveAndGet operation.

• Media Type Column Name

  The collection metadata component that specifies the name of the column that stores the media type of the document. A media type column is needed if the collection is to be heterogeneous, that is, it can store documents other than JavaScript Object Notation (JSON).

• Read Only The collection metadata component that specifies whether the collection is read-only.

Related Topics

• Overview of SODA Document Collections

1. Reminder: letter case is significant for a quoted SQL identifier; it is interpreted case-sensitively. ↩