Preparing search index...
The search index is not available
@datastax/astra-db-ts
@datastax/astra-db-ts
CollectionDesCtx
Interface CollectionDesCtx
Beta
interface
CollectionDesCtx
{
deserializers
:
Deserializers
<
CollectionDesCtx
>
;
getNumCoercionForPath
?:
CollNumCoercionFn
;
locals
:
Record
<
string
,
any
>
;
mutatingInPlace
:
boolean
;
path
:
PathSegment
[]
;
rawDataApiResp
:
RawDataAPIResponse
;
rootObj
:
any
;
target
:
number
;
done
<
T
>
(
obj
?
)
:
readonly
[
0
,
undefined
|
T
]
;
mapAfter
(
map
)
:
readonly
[
3
]
;
nevermind
(
)
:
readonly
[
3
]
;
recurse
<
T
>
(
obj
?
)
:
readonly
[
1
,
undefined
|
T
]
;
replace
<
T
>
(
obj
)
:
readonly
[
2
,
T
]
;
}
Hierarchy (
view full
)
BaseDesCtx
<
CollectionDesCtx
>
CollectionDesCtx
Index
Properties
deserializers
get
Num
Coercion
For
Path?
locals
mutating
In
Place
path
raw
Data
Api
Resp
root
Obj
target
Methods
done
map
After
nevermind
recurse
replace
Properties
deserializers
deserializers
:
Deserializers
<
CollectionDesCtx
>
Optional
get
Num
Coercion
For
Path
get
Num
Coercion
For
Path
?:
CollNumCoercionFn
locals
locals
:
Record
<
string
,
any
>
mutating
In
Place
mutating
In
Place
:
boolean
path
path
:
PathSegment
[]
raw
Data
Api
Resp
raw
Data
Api
Resp
:
RawDataAPIResponse
root
Obj
root
Obj
:
any
target
target
:
number
Methods
done
done
<
T
>
(
obj
?
)
:
readonly
[
0
,
undefined
|
T
]
Type Parameters
T
Parameters
Optional
obj
:
T
Returns
readonly
[
0
,
undefined
|
T
]
map
After
map
After
(
map
)
:
readonly
[
3
]
Parameters
map
:
(
(
v
)
=>
unknown
)
(
v
)
:
unknown
Parameters
v
:
any
Returns
unknown
Returns
readonly
[
3
]
nevermind
nevermind
(
)
:
readonly
[
3
]
Returns
readonly
[
3
]
recurse
recurse
<
T
>
(
obj
?
)
:
readonly
[
1
,
undefined
|
T
]
Type Parameters
T
Parameters
Optional
obj
:
T
Returns
readonly
[
1
,
undefined
|
T
]
replace
replace
<
T
>
(
obj
)
:
readonly
[
2
,
T
]
Type Parameters
T
Parameters
obj
:
T
Returns
readonly
[
2
,
T
]
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
deserializers
get
Num
Coercion
For
Path
locals
mutating
In
Place
path
raw
Data
Api
Resp
root
Obj
target
done
map
After
nevermind
recurse
replace
@datastax/astra-db-ts
BigNumber
Config
Format
Instance
Constructor
ModuloMode
RoundingMode
Value
PropagationState
AWSEmbeddingHeadersProvider
AbstractCursor
AdminCommandEvent
AdminCommandFailedEvent
AdminCommandPollingEvent
AdminCommandStartedEvent
AdminCommandSucceededEvent
AdminCommandWarningsEvent
AstraAdmin
AstraDbAdmin
BaseClientEvent
BigNumber
Collection
CollectionCodecs
CollectionDeleteManyError
CollectionFindAndRerankCursor
CollectionFindCursor
CollectionInsertManyError
CollectionUpdateManyError
CommandEvent
CommandFailedEvent
CommandStartedEvent
CommandSucceededEvent
CommandWarningsEvent
CursorError
DataAPIBlob
DataAPIClient
DataAPIDate
DataAPIDbAdmin
DataAPIDuration
DataAPIDurationBuilder
DataAPIError
DataAPIHttpError
DataAPIInet
DataAPIResponseError
DataAPITime
DataAPITimeoutError
DataAPIVector
Db
DbAdmin
DevOpsAPIError
DevOpsAPIResponseError
DevOpsAPITimeoutError
EmbeddingAPIKeyHeaderProvider
FetchH2
FetchNative
FindAndRerankCursor
FindCursor
HeadersProvider
HierarchicalLogger
InvalidEnvironmentError
NumCoercionError
ObjectId
PureHeadersProvider
RerankedResult
RerankingAPIKeyHeaderProvider
StaticHeadersProvider
StaticTokenProvider
Table
TableCodecs
TableFindAndRerankCursor
TableFindCursor
TableInsertManyError
TokenProvider
TooManyDocumentsToCountError
UUID
UnexpectedDataAPIResponseError
UsernamePasswordTokenProvider
AddColumnOperation
AddRerankingOperation
AddVectorizeOperation
AdminOptions
AlterTableOperations
AlterTableOptions
AsCollectionCodecClassFns
AsTableCodecClassFns
AstraBaseDatabaseInfo
AstraDatabaseConfig
AstraDatabaseRegionInfo
AstraFullDatabaseInfo
AstraNoBlockingOptions
AstraPartialDatabaseInfo
AstraPollBlockingOptions
BaseDesCtx
BaseSerCtx
BaseSerDesConfig
BaseSerDesCtx
CollNumCoercionCfg
CollectionArrayFilterOps
CollectionDefaultIdOptions
CollectionDefinition
CollectionDeleteOneResult
CollectionDesCtx
CollectionDescriptor
CollectionInsertManyResult
CollectionInsertOneResult
CollectionLexicalOptions
CollectionOptions
CollectionRerankOptions
CollectionSerCtx
CollectionSerDesConfig
CollectionUpdateFilter
CollectionVectorOptions
CreateCollectionOptions
CreateDataAPIKeyspaceOptions
CreateTableDefinition
CreateTableOptions
CustomHttpClientOptions
DataAPIClientOptions
DataAPIErrorDescriptor
DbOptions
DbSerDesConfig
Deserializers
DevOpsAPIErrorDescriptor
DropCollectionOptions
DropColumnOperation
DropTableOptions
DropVectorizeOperation
EmbeddingProviderAuthInfo
EmbeddingProviderInfo
EmbeddingProviderModelInfo
EmbeddingProviderModelParameterInfo
EmbeddingProviderProviderParameterInfo
EmbeddingProviderTokenInfo
ExplicitLoggingConfig
FetchH2Http1Options
FetchH2HttpClientOptions
FetchH2Like
FetchHttpClientOptions
Fetcher
FetcherRequestInfo
FetcherResponseInfo
FindEmbeddingProvidersResult
FindRerankingProvidersResult
FullCreateTablePrimaryKeyDefinition
GenericDeleteManyResult
GenericDeleteOneOptions
GenericDeleteOneResult
GenericFindAndRerankOptions
GenericFindOneAndDeleteOptions
GenericFindOneAndReplaceOptions
GenericFindOneAndUpdateOptions
GenericFindOneOptions
GenericFindOptions
GenericInsertManyOrderedOptions
GenericInsertManyUnorderedOptions
GenericReplaceOneOptions
GenericUpdateManyOptions
GenericUpdateOneOptions
GetHeadersCtx
GuaranteedUpdateResult
HybridSortObject
LexicalDoc
ListAstraDatabasesOptions
ListCollectionsOptions
ListTableDefinition
ListTableUnsupportedColumnApiSupport
ListTableUnsupportedColumnDefinition
ListTablesOptions
NoUpsertUpdateResult
NominalCodecOpts
ProjectionSlice
RawDataAPIResponse
Ref
RerankServiceOptions
RunCommandOptions
Serializers
SomeIdTypes
TableCreateIndexOptions
TableCreateTextIndexOptions
TableCreateVectorIndexOptions
TableDesCtx
TableDescriptor
TableDropIndexOptions
TableFilterOps
TableIndexOptions
TableInsertManyResult
TableInsertOneResult
TableListColumnDefinition
TableMapColumnDefinition
TableOptions
TableScalarColumnDefinition
TableSerCtx
TableSerDesConfig
TableSetColumnDefinition
TableTextIndexOptions
TableUpdateFilter
TableVectorColumnDefinition
TableVectorIndexOptions
TimeoutDescriptor
UpsertedUpdateResult
VectorDoc
VectorizeDoc
VectorizeServiceOptions
WithKeyspace
WithTimeout
AdditionalHeaders
AdminCommandEventMap
AstraAdminBlockingOptions
AstraDatabaseCloudProvider
AstraDatabaseCloudProviderFilter
AstraDatabaseStatus
AstraDatabaseStatusFilter
AstraDropDatabaseOptions
Caller
CollCustomCodecOpts
CollNominalCodecOpts
CollNumCoercion
CollNumCoercionFn
CollTypeCodecOpts
CollectionArrayUpdate
CollectionCodec
CollectionCodecClass
CollectionCountDocumentsOptions
CollectionCurrentDate
CollectionDateUpdate
CollectionDeleteManyOptions
CollectionDeleteManyResult
CollectionDeleteOneOptions
CollectionDistinctOptions
CollectionEstimatedDocumentCountOptions
CollectionFilter
CollectionFilterExpr
CollectionFilterOps
CollectionFindAndRerankOptions
CollectionFindOneAndDeleteOptions
CollectionFindOneAndReplaceOptions
CollectionFindOneAndUpdateOptions
CollectionFindOneOptions
CollectionFindOptions
CollectionIndexingOptions
CollectionInsertManyOptions
CollectionInsertOneOptions
CollectionNumberUpdate
CollectionPop
CollectionPush
CollectionReplaceOneOptions
CollectionReplaceOneResult
CollectionUpdateManyOptions
CollectionUpdateManyResult
CollectionUpdateOneOptions
CollectionUpdateOneResult
CommandEventMap
CommandEventTarget
ContainsDate
CqlType2TSType
CreateAstraDatabaseOptions
CreateAstraKeyspaceOptions
CreateTableColumnDefinitions
CursorState
CustomCodecOpts
CustomCodecSerOpts
DataAPIBlobLike
DataAPIClientEvent
DataAPIClientEventMap
DataAPICodec
DataAPIEnvironment
DataAPIVectorLike
DataAPIWarningDescriptor
DropAstraKeyspaceOptions
DropRerankingOperation
EmbeddingHeadersProvider
EmptyObj
EventFormatter
Filter
Flatten
FoundDoc
FoundRow
GenericCountOptions
GenericDeleteManyOptions
GenericDistinctOptions
GenericEstimatedCountOptions
GenericInsertManyOptions
GenericInsertOneOptions
GenericUpdateResult
HeadersProviderVariants
HttpOptions
HybridSort
IdOf
InferTablePrimaryKey
InferTableReadSchema
InferTableSchema
InferrableTableSchema
IsAny
IsDate
IsNum
KeyspaceReplicationOptions
ListTableColumnDefinitions
ListTableKnownColumnDefinition
ListTablePrimaryKeyDefinition
LitUnion
LoggingConfig
LoggingEvent
LoggingOutput
LooseCreateTableColumnDefinition
MaybeBuffer
MaybeId
NoId
NonEmpty
OneOrMany
OpaqueHttpClient
PathSegment
PickArrayTypes
Projection
RawCodec
RawCollCodecs
RawTableCodecs
ReadonlyNonEmpty
RerankingHeadersProvider
RootAdminOptions
RootDbOptions
SerDesFn
SerDesFnRet
SerDesGuard
SerDesTarget
SomeConstructor
SomeDoc
SomeId
SomePKey
SomeRow
Sort
SortDirection
StrictCreateTableColumnDefinition
TableCodec
TableCodecClass
TableCreateIndexColumn
TableCustomCodecOpts
TableDeleteManyOptions
TableDeleteOneOptions
TableFilter
TableFilterExpr
TableFindAndRerankOptions
TableFindOneOptions
TableFindOptions
TableInsertManyOptions
TableInsertOneOptions
TableNominalCodecOpts
TablePrimaryKeyDefinition
TableScalarType
TableSchemaTypeOverrides
TableTypeCodecOpts
TableUpdateOneOptions
TimedOutCategories
ToDotNotation
TypeCodecOpts
UpdateFilter
WithId
WithSim
nullish
$DeserializeForCollection
$DeserializeForTable
$SerializeForCollection
$SerializeForTable
DEFAULT_KEYSPACE
DataAPIEnvironments
LIB_NAME
LIB_VERSION
LoggingEvents
LoggingOutputs
SerDesTarget
blob
buildAstraEndpoint
date
duration
escapeFieldNames
genObjectId
inet
oid
time
unescapeFieldPath
uuid
vector