Configuration for encrypted column indexes and data types EncryptedColumnConfig in the @cipherstash/stack TypeScript API reference.

Type Alias: EncryptedColumnConfig

type EncryptedColumnConfig = {
  dataType?: CastAs;
  freeTextSearch?:   | boolean
     | MatchIndexOpts;
  equality?:   | boolean
     | TokenFilter[];
  orderAndRange?: boolean;
  searchableJson?: boolean;
};

Defined in: packages/stack/src/drizzle/index.ts:23

Configuration for encrypted column indexes and data types

Properties

dataType?

optional dataType: CastAs;

Defined in: packages/stack/src/drizzle/index.ts:27

Data type for the column (default: 'string')

freeTextSearch?

optional freeTextSearch: 
  | boolean
  | MatchIndexOpts;

Defined in: packages/stack/src/drizzle/index.ts:31

Enable free text search. Can be a boolean for default options, or an object for custom configuration.

equality?

optional equality: 
  | boolean
  | TokenFilter[];

Defined in: packages/stack/src/drizzle/index.ts:35

Enable equality index. Can be a boolean for default options, or an array of token filters.

orderAndRange?

optional orderAndRange: boolean;

Defined in: packages/stack/src/drizzle/index.ts:39

Enable order and range index for sorting and range queries.

searchableJson?

optional searchableJson: boolean;

Defined in: packages/stack/src/drizzle/index.ts:44

Enable searchable JSON index for JSONB path queries. Requires dataType: 'json'.

EncryptedColumnConfig