@midwayjs/tablestore

Index

Classes

• CompositeCondition
• Condition
• Configuration
• SingleColumnCondition
• TableStoreService
• TableStoreServiceFactory

Enumerations

• ColumnConditionType
• ColumnReturnType
• ComparatorType
• DefinedColumnType
• Direction
• FieldType
• FilterType
• GeoDistanceType
• IndexOptions
• IndexType
• IndexUpdateMode
• LogicalOperator
• PrimaryKeyOption
• PrimaryKeyType
• QueryOperator
• QueryType
• ReturnType
• RowExistenceExpectation
• ScoreMode
• SortMode
• SortOrder
• UpdateType

Functions

• formatRow
• formatRows

Interfaces

• BatchGetRowParams
• BatchWriteRowParams
• ColumnCondition
• CreateIndexParams
• CreateSearchIndexParams
• CreateTableParams
• DeleteRowParams
• DeleteSearchIndexParams
• DeleteTableParams
• DescribeSearchIndexParams
• DescribeTableParams
• DropIndexParams
• GetRangeParams
• GetRowParams
• ListSearchIndexParams
• PutRowParams
• SearchIndexFieldSchema
• SearchIndexNestedFilter
• SearchIndexSchema
• SearchIndexSetting
• SearchIndexSorter
• SearchParams
• SearchQuery
• StartLocalTransactionParams
• TableStoreClient
• TableStoreCompositeCondition
• TableStoreCondition
• TableStoreConfig
• TableStoreLong
• TableStoreResult
• TableStoreSingleColumnCondition
• UpdateRowParams
• UpdateTableParams

Type Aliases

• AbortTransactionParams
• AttributeColumn
• BatchWriteRowItem
• ColumnValue
• CommitTransactionParams
• ExtraMetadata
• ListTableParams
• PrimaryKey
• PrimaryKeyValue
• SearchIndexQuery
• UpdateColumn

Variables

• INF_MAX
• INF_MIN
• Long
• PK_AUTO_INCR

Type Aliases

AbortTransactionParams

AbortTransactionParams: string | { transactionId: string }

AttributeColumn

AttributeColumn: { timestamp?: number }

BatchWriteRowItem

BatchWriteRowItem: ({ attributeColumns?: AttributeColumn[]; type: PUT | DELETE } | { type: UPDATE; updateOfAttributeColumns: UpdateColumn[] }) & { condition?: TableStoreCondition | null; primaryKey: PrimaryKey[]; returnContent?: { returnColumns?: string[]; returnType?: ReturnType } }

ColumnValue

ColumnValue: number | boolean | PrimaryKeyValue

CommitTransactionParams

CommitTransactionParams: string | { transactionId: string }

ExtraMetadata

ExtraMetadata: typeof INF_MIN & typeof INF_MAX & typeof PK_AUTO_INCR

protocol/proto_buffer

ListTableParams

ListTableParams: undefined | null | {}

PrimaryKey

PrimaryKey: {}

PrimaryKeyValue

PrimaryKeyValue: Int64LE | string | Buffer

SearchIndexQuery

SearchIndexQuery: { query?: { fieldName: string; minimumShouldMatch?: number; operator?: QueryOperator; text?: string }; queryType?: QueryType.MATCH_QUERY } | { query?: { fieldName: string; text?: string }; queryType?: QueryType.MATCH_PHRASE_QUERY } | { query?: { fieldName: string; term: ColumnValue }; queryType?: QueryType.TERM_QUERY } | { query?: { fieldName: string; includeLower?: boolean; includeUpper?: boolean; rangeFrom?: ColumnValue; rangeTo?: ColumnValue }; queryType?: QueryType.RANGE_QUERY } | { query?: { fieldName: string; prefix?: string }; queryType?: QueryType.PREFIX_QUERY } | { query?: { filterQueries?: SearchIndexQuery[]; minimumShouldMatch?: number; mustNotQueries?: SearchIndexQuery[]; mustQueries?: SearchIndexQuery[]; shouldQueries?: SearchIndexQuery[] }; queryType?: QueryType.BOOL_QUERY } | { query?: { filter: SearchIndexQuery }; queryType?: QueryType.CONST_SCORE_QUERY } | { query?: { fieldValueFactor: { fieldName: string }; query: SearchIndexQuery }; queryType?: QueryType.FUNCTION_SCORE_QUERY } | { query?: { path: string; query: SearchIndexQuery; scoreMode?: ScoreMode }; type?: QueryType.NESTED_QUERY } | { query?: { fieldName: string; value?: string }; queryType?: QueryType.WILDCARD_QUERY } | { query?: {}; queryType?: QueryType.MATCH_ALL_QUERY } | { query?: { bottomRight?: string; fieldName: string; topLeft?: string }; queryType?: QueryType.GEO_BOUNDING_BOX_QUERY } | { query?: { centerPoint?: string; distance?: number; fieldName: string }; queryType?: QueryType.GEO_DISTANCE_QUERY } | { query?: { fieldName: string; points?: string[] }; queryType?: QueryType.GEO_POLYGON_QUERY } | { query?: { fieldName: string; terms?: ColumnValue[] }; queryType?: QueryType.TERMS_QUERY } | { query?: { fieldName: string }; queryType?: QueryType.EXISTS_QUERY }

UpdateColumn

UpdateColumn: { [ key in UpdateType.DELETE_ALL ]?: string[] } & { [ key in Exclude<UpdateType, UpdateType.DELETE_ALL> ]?: AttributeColumn[] }

Variables

constINF_MAX

INF_MAX: any = TableStore.INF_MAX

constINF_MIN

INF_MIN: any = TableStore.INF_MIN

constLong

Long: TableStoreLong = ...

constPK_AUTO_INCR

PK_AUTO_INCR: any = TableStore.PK_AUTO_INCR