Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Collection

export
namespace

Collection

Index

Properties

Optional aliases

aliases: Array<Alias>

list of aliases for a collection

memberof

Collection

Optional clustering_key

clustering_key: Array<FieldPartition>

list of clustering fields for a collection

memberof

Collection

Optional created_at

created_at: undefined | string

ISO-8601 date

memberof

Collection

Optional created_by

created_by: undefined | string

email of user who created the collection

memberof

Collection

Optional description

description: undefined | string

text describing the collection

memberof

Collection

Optional enable_exactly_once_writes

enable_exactly_once_writes: undefined | false | true

If true, exactly-once write semantics is enabled.

memberof

Collection

Optional field_mapping_query

field_mapping_query: FieldMappingQuery

Field mapping for a collection

memberof

Collection

Optional field_mappings

field_mappings: Array<FieldMappingV2>

list of mappings applied on all documents in a collection

memberof

Collection

Optional field_partitions

field_partitions: Array<FieldPartition>

list of partitions for a collection

memberof

Collection

Optional field_schemas

field_schemas: Array<FieldSchema>

list of field schemas

memberof

Collection

Optional insert_only

insert_only: undefined | false | true

Whether the collection is insert only or not

memberof

Collection

Optional inverted_index_group_encoding_options

inverted_index_group_encoding_options: InvertedIndexGroupEncodingOptions

inverted index group encoding options

memberof

Collection

Optional name

name: undefined | string

unique identifer for collection, can contain alphanumeric or dash characters

memberof

Collection

Optional retention_secs

retention_secs: undefined | number

number of seconds after which data is purged based on event time

memberof

Collection

Optional sources

sources: Array<Source>

list of sources from which collection ingests

memberof

Collection

Optional stats

metrics about the collection

memberof

Collection

Optional status

status: StatusEnum

current status of collection, one of: CREATED, READY, DELETED

memberof

Collection

Optional workspace

workspace: undefined | string

name of the workspace that the collection is in

memberof

Collection

Generated using TypeDoc