IntegrationsPrisma ORMAPI reference

column-types

column-types is a module in @cipherstash/stack-prisma. TypeScript API reference with its signature, parameters, and usage.

@cipherstash/stack-prisma

column-types

Interfaces

V3ColumnDescriptor

Defined in: column-types.ts:53

Literal-preserving authoring descriptor, generic over the concrete stack column C. codecId, nativeType, and capabilities are the domain's LITERAL types (not string / unknown), so two domains' factories are mutually non-assignable — this is the type spine (design "Type Discipline"). castAs is the one field the stack widens (build(): ColumnSchema), which is harmless: nativeType already discriminates every domain. Pinned by the type-level tests in test/v3/column-types.test-d.ts.

Type Parameters

C

C extends AnyEncryptedV3Column

Properties

codecId

readonly codecId: `cipherstash/eql-v3/${StripPublic&lt;EqlTypeFromGetter&lt;C&gt;>}@1`;

Defined in: column-types.ts:54

nativeType

readonly nativeType: EqlTypeFromGetter&lt;C&gt;;

Defined in: column-types.ts:55

typeParams

readonly typeParams: {
  castAs: V3CastAs;
  capabilities: CapabilitiesFromGetter&lt;C&gt;;
};

Defined in: column-types.ts:56

castAs

readonly castAs: V3CastAs;

capabilities

readonly capabilities: CapabilitiesFromGetter&lt;C&gt;;

Variables

text()

const text: () => V3ColumnDescriptor&lt;EncryptedTextColumn&gt;;

Defined in: column-types.ts:105

Returns

V3ColumnDescriptor<EncryptedTextColumn>

textEq()

const textEq: () => V3ColumnDescriptor&lt;EncryptedTextEqColumn&gt;;

Defined in: column-types.ts:106

Returns

V3ColumnDescriptor<EncryptedTextEqColumn>

textOrd()

const textOrd: () => V3ColumnDescriptor&lt;EncryptedTextOrdColumn&gt;;

Defined in: column-types.ts:107

Returns

V3ColumnDescriptor<EncryptedTextOrdColumn>

textMatch()

const textMatch: () => V3ColumnDescriptor&lt;EncryptedTextMatchColumn&gt;;

Defined in: column-types.ts:108

Returns

V3ColumnDescriptor<EncryptedTextMatchColumn>

textSearch()

const textSearch: () => V3ColumnDescriptor&lt;EncryptedTextSearchColumn&gt;;

Defined in: column-types.ts:109

Returns

V3ColumnDescriptor<EncryptedTextSearchColumn>

integer()

const integer: () => V3ColumnDescriptor&lt;EncryptedIntegerColumn&gt;;

Defined in: column-types.ts:111

Returns

V3ColumnDescriptor<EncryptedIntegerColumn>

integerEq()

const integerEq: () => V3ColumnDescriptor&lt;EncryptedIntegerEqColumn&gt;;

Defined in: column-types.ts:112

Returns

V3ColumnDescriptor<EncryptedIntegerEqColumn>

integerOrd()

const integerOrd: () => V3ColumnDescriptor&lt;EncryptedIntegerOrdColumn&gt;;

Defined in: column-types.ts:113

Returns

V3ColumnDescriptor<EncryptedIntegerOrdColumn>

smallint()

const smallint: () => V3ColumnDescriptor&lt;EncryptedSmallintColumn&gt;;

Defined in: column-types.ts:115

Returns

V3ColumnDescriptor<EncryptedSmallintColumn>

smallintEq()

const smallintEq: () => V3ColumnDescriptor&lt;EncryptedSmallintEqColumn&gt;;

Defined in: column-types.ts:116

Returns

V3ColumnDescriptor<EncryptedSmallintEqColumn>

smallintOrd()

const smallintOrd: () => V3ColumnDescriptor&lt;EncryptedSmallintOrdColumn&gt;;

Defined in: column-types.ts:117

Returns

V3ColumnDescriptor<EncryptedSmallintOrdColumn>

bigInt()

const bigInt: () => V3ColumnDescriptor&lt;EncryptedBigintColumn&gt;;

Defined in: column-types.ts:119

Returns

V3ColumnDescriptor<EncryptedBigintColumn>

bigIntEq()

const bigIntEq: () => V3ColumnDescriptor&lt;EncryptedBigintEqColumn&gt;;

Defined in: column-types.ts:120

Returns

V3ColumnDescriptor<EncryptedBigintEqColumn>

bigIntOrd()

const bigIntOrd: () => V3ColumnDescriptor&lt;EncryptedBigintOrdColumn&gt;;

Defined in: column-types.ts:121

Returns

V3ColumnDescriptor<EncryptedBigintOrdColumn>

numeric()

const numeric: () => V3ColumnDescriptor&lt;EncryptedNumericColumn&gt;;

Defined in: column-types.ts:123

Returns

V3ColumnDescriptor<EncryptedNumericColumn>

numericEq()

const numericEq: () => V3ColumnDescriptor&lt;EncryptedNumericEqColumn&gt;;

Defined in: column-types.ts:124

Returns

V3ColumnDescriptor<EncryptedNumericEqColumn>

numericOrd()

const numericOrd: () => V3ColumnDescriptor&lt;EncryptedNumericOrdColumn&gt;;

Defined in: column-types.ts:125

Returns

V3ColumnDescriptor<EncryptedNumericOrdColumn>

real()

const real: () => V3ColumnDescriptor&lt;EncryptedRealColumn&gt;;

Defined in: column-types.ts:127

Returns

V3ColumnDescriptor<EncryptedRealColumn>

realEq()

const realEq: () => V3ColumnDescriptor&lt;EncryptedRealEqColumn&gt;;

Defined in: column-types.ts:128

Returns

V3ColumnDescriptor<EncryptedRealEqColumn>

realOrd()

const realOrd: () => V3ColumnDescriptor&lt;EncryptedRealOrdColumn&gt;;

Defined in: column-types.ts:129

Returns

V3ColumnDescriptor<EncryptedRealOrdColumn>

double()

const double: () => V3ColumnDescriptor&lt;EncryptedDoubleColumn&gt;;

Defined in: column-types.ts:131

Returns

V3ColumnDescriptor<EncryptedDoubleColumn>

doubleEq()

const doubleEq: () => V3ColumnDescriptor&lt;EncryptedDoubleEqColumn&gt;;

Defined in: column-types.ts:132

Returns

V3ColumnDescriptor<EncryptedDoubleEqColumn>

doubleOrd()

const doubleOrd: () => V3ColumnDescriptor&lt;EncryptedDoubleOrdColumn&gt;;

Defined in: column-types.ts:133

Returns

V3ColumnDescriptor<EncryptedDoubleOrdColumn>

date()

const date: () => V3ColumnDescriptor&lt;EncryptedDateColumn&gt;;

Defined in: column-types.ts:135

Returns

V3ColumnDescriptor<EncryptedDateColumn>

dateEq()

const dateEq: () => V3ColumnDescriptor&lt;EncryptedDateEqColumn&gt;;

Defined in: column-types.ts:136

Returns

V3ColumnDescriptor<EncryptedDateEqColumn>

dateOrd()

const dateOrd: () => V3ColumnDescriptor&lt;EncryptedDateOrdColumn&gt;;

Defined in: column-types.ts:137

Returns

V3ColumnDescriptor<EncryptedDateOrdColumn>

timestamp()

const timestamp: () => V3ColumnDescriptor&lt;EncryptedTimestampColumn&gt;;

Defined in: column-types.ts:139

Returns

V3ColumnDescriptor<EncryptedTimestampColumn>

timestampEq()

const timestampEq: () => V3ColumnDescriptor&lt;EncryptedTimestampEqColumn&gt;;

Defined in: column-types.ts:140

Returns

V3ColumnDescriptor<EncryptedTimestampEqColumn>

timestampOrd()

const timestampOrd: () => V3ColumnDescriptor&lt;EncryptedTimestampOrdColumn&gt;;

Defined in: column-types.ts:141

Returns

V3ColumnDescriptor<EncryptedTimestampOrdColumn>

boolean()

const boolean: () => V3ColumnDescriptor&lt;EncryptedBooleanColumn&gt;;

Defined in: column-types.ts:143

Returns

V3ColumnDescriptor<EncryptedBooleanColumn>

json()

const json: () => V3ColumnDescriptor&lt;EncryptedJsonColumn&gt;;

Defined in: column-types.ts:145

Returns

V3ColumnDescriptor<EncryptedJsonColumn>

codec-types

codec-types is a module in @cipherstash/stack-prisma. TypeScript API reference with its signature, parameters, and usage.

control

control is a module in @cipherstash/stack-prisma. TypeScript API reference with its signature, parameters, and usage.