Module models

Module models 

Source

Modules§

alter_table_add_columns_request
alter_table_add_columns_response
alter_table_alter_columns_request
alter_table_alter_columns_response
alter_table_drop_columns_request
alter_table_drop_columns_response
alter_transaction_action
alter_transaction_request
alter_transaction_response
alter_transaction_set_property
alter_transaction_set_status
alter_transaction_unset_property
analyze_table_query_plan_request
analyze_table_query_plan_response
boolean_query
boost_query
column_alteration
count_table_rows_request
create_empty_table_request
create_empty_table_response
create_namespace_request
create_namespace_response
create_table_index_request
create_table_index_response
create_table_request
create_table_response
create_table_tag_request
delete_from_table_request
delete_from_table_response
delete_table_tag_request
deregister_table_request
deregister_table_response
describe_namespace_request
describe_namespace_response
describe_table_index_stats_request
describe_table_index_stats_response
describe_table_request
describe_table_response
describe_transaction_request
describe_transaction_response
drop_namespace_request
drop_namespace_response
drop_table_index_request
drop_table_index_response
drop_table_request
drop_table_response
error_response
explain_table_query_plan_request
explain_table_query_plan_response
fts_query
get_table_stats_request
get_table_stats_response
get_table_tag_version_request
get_table_tag_version_response
index_content
insert_into_table_request
insert_into_table_response
json_arrow_data_type
json_arrow_field
json_arrow_schema
list_namespaces_request
list_namespaces_response
list_table_indices_request
list_table_indices_response
list_table_tags_response
list_table_versions_request
list_table_versions_response
list_tables_request
list_tables_response
match_query
merge_insert_into_table_request
merge_insert_into_table_response
multi_match_query
namespace_exists_request
new_column_transform
operator
phrase_query
query_table_request
query_table_request_full_text_query
query_table_request_vector
register_table_request
register_table_response
restore_table_request
restore_table_response
set_property_mode
string_fts_query
structured_fts_query
table_exists_request
table_version
tag_contents
transaction_status
unset_property_mode
update_table_request
update_table_response
update_table_tag_request

Structs§

AlterTableAddColumnsRequest
AlterTableAddColumnsResponse
AlterTableAlterColumnsRequest
AlterTableAlterColumnsResponse
AlterTableDropColumnsRequest
AlterTableDropColumnsResponse
AlterTransactionAction
AlterTransactionAction : A single action that could be performed to alter a transaction. This action holds the model definition for all types of specific actions models, this is to minimize difference and compatibility issue across codegen in different languages. When used, only one of the actions should be non-null for each action. If you would like to perform multiple actions, set a list of actions in the AlterTransactionRequest.
AlterTransactionRequest
AlterTransactionRequest : Alter a transaction with a list of actions. The server should either succeed and apply all actions, or fail and apply no action.
AlterTransactionResponse
AlterTransactionSetProperty
AlterTransactionSetStatus
AlterTransactionUnsetProperty
AnalyzeTableQueryPlanRequest
AnalyzeTableQueryPlanResponse
BooleanQuery
BooleanQuery : Boolean query with must, should, and must_not clauses
BoostQuery
BoostQuery : Boost query that scores documents matching positive query higher and negative query lower
ColumnAlteration
CountTableRowsRequest
CreateEmptyTableRequest
CreateEmptyTableRequest : Request for creating an empty table.
CreateEmptyTableResponse
CreateEmptyTableResponse : Response for creating an empty table.
CreateNamespaceRequest
CreateNamespaceResponse
CreateTableIndexRequest
CreateTableIndexResponse
CreateTableRequest
CreateTableRequest : Request for creating a table, excluding the Arrow IPC stream.
CreateTableResponse
CreateTableTagRequest
DeleteFromTableRequest
DeleteFromTableRequest : Delete data from table based on a SQL predicate. Returns the number of rows that were deleted.
DeleteFromTableResponse
DeleteTableTagRequest
DeregisterTableRequest
DeregisterTableRequest : The table content remains available in the storage.
DeregisterTableResponse
DescribeNamespaceRequest
DescribeNamespaceResponse
DescribeTableIndexStatsRequest
DescribeTableIndexStatsResponse
DescribeTableRequest
DescribeTableResponse
DescribeTransactionRequest
DescribeTransactionResponse
DropNamespaceRequest
DropNamespaceResponse
DropTableIndexRequest
DropTableIndexResponse
DropTableRequest
DropTableRequest : If the table and its data can be immediately deleted, return information of the deleted table. Otherwise, return a transaction ID that client can use to track deletion progress.
DropTableResponse
ErrorResponse
ErrorResponse : Common JSON error response model
ExplainTableQueryPlanRequest
ExplainTableQueryPlanResponse
FtsQuery
FtsQuery : Full-text search query. Exactly one query type field must be provided. This structure follows the same pattern as AlterTransactionAction to minimize differences and compatibility issues across codegen in different languages.
GetTableStatsRequest
GetTableStatsResponse
GetTableTagVersionRequest
GetTableTagVersionResponse
IndexContent
InsertIntoTableRequest
InsertIntoTableRequest : Request for inserting records into a table, excluding the Arrow IPC stream.
InsertIntoTableResponse
InsertIntoTableResponse : Response from inserting records into a table
JsonArrowDataType
JsonArrowDataType : JSON representation of an Apache Arrow DataType
JsonArrowField
JsonArrowField : JSON representation of an Apache Arrow field.
JsonArrowSchema
JsonArrowSchema : JSON representation of a Apache Arrow schema.
ListNamespacesRequest
ListNamespacesResponse
ListTableIndicesRequest
ListTableIndicesResponse
ListTableTagsResponse
ListTableVersionsRequest
ListTableVersionsResponse
ListTablesRequest
ListTablesResponse
MatchQuery
MergeInsertIntoTableRequest
MergeInsertIntoTableRequest : Request for merging or inserting records into a table, excluding the Arrow IPC stream.
MergeInsertIntoTableResponse
MergeInsertIntoTableResponse : Response from merge insert operation
MultiMatchQuery
NamespaceExistsRequest
NewColumnTransform
PhraseQuery
QueryTableRequest
QueryTableRequestFullTextQuery
QueryTableRequestFullTextQuery : Optional full-text search query. Provide either string_query or structured_query, not both.
QueryTableRequestVector
QueryTableRequestVector : Query vector(s) for similarity search. Provide either single_vector or multi_vector, not both.
RegisterTableRequest
RegisterTableResponse
RestoreTableRequest
RestoreTableResponse
StringFtsQuery
StructuredFtsQuery
TableExistsRequest
TableVersion
TagContents
UpdateTableRequest
UpdateTableRequest : Each update consists of a column name and an SQL expression that will be evaluated against the current row’s value. Optionally, a predicate can be provided to filter which rows to update.
UpdateTableResponse
UpdateTableTagRequest

Enums§

Operator
SetPropertyMode
SetPropertyMode : The behavior if the property key already exists. - OVERWRITE (default): overwrite the existing value with the provided value - FAIL: fail the entire operation - SKIP: keep the existing value and skip setting the provided value The behavior if the property key already exists. - OVERWRITE (default): overwrite the existing value with the provided value - FAIL: fail the entire operation - SKIP: keep the existing value and skip setting the provided value
TransactionStatus
UnsetPropertyMode
UnsetPropertyMode : The behavior if the property key to unset does not exist. - SKIP (default): skip the property to unset - FAIL: fail the entire operation The behavior if the property key to unset does not exist. - SKIP (default): skip the property to unset - FAIL: fail the entire operation