Interface DbSerDesConfig

Overview

The config for table/collection serialization/deserialization options.

See TableSerDesConfig and CollectionSerDesConfig for more much information on the available options.

Such options include:

  • Enabling the mutateInPlace optimization for serializing rows/documents
  • Enabling big number support for collections
  • Enabling "sparse data" for tables
  • Implementing custom serialization/deserialization logic through codecs
    • (e.g. custom data types, validation, etc.)
Disclaimer

Some of these options are advanced features, and should be used with caution. It's possible to break the client's behavior by using these features incorrectly.

Unstable features are marked in the documentation as @alpha or @beta, and may change in the future.

See

  • CollectionSerDesConfig
  • TableSerDesConfig
interface DbSerDesConfig {
    collection?: Omit<CollectionSerDesConfig, "mutateInPlace">;
    mutateInPlace?: boolean;
    table?: Omit<TableSerDesConfig, "mutateInPlace">;
}

Properties

collection? mutateInPlace? table?

Properties

Optional collection

collection?: Omit<CollectionSerDesConfig, "mutateInPlace">

Advanced & currently somewhat unstable features related to customizing spawned collections' ser/des behavior at a lower level.

Use with caution. See official DataStax documentation for more info.

Optional mutateInPlace

mutateInPlace?: boolean
Overview

Enables an optimization which allows inserted rows/documents to be mutated in-place when serializing, instead of cloning them before serialization.

Stable. Will mutate filters & update filters as well.

See BaseSerDesConfig.mutateInPlace for more information.

Default Value

false

Optional table

table?: Omit<TableSerDesConfig, "mutateInPlace">

Advanced & currently somewhat unstable features related to customizing spawned tables' ser/des behavior at a lower level.

Use with caution. See official DataStax documentation for more info.

Settings

Member Visibility

Theme

On This Page

collectionmutateInPlacetable