Skip to main content Module models Copy item path Source add_virtual_column_entry alter_columns_entry 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 alter_virtual_column_entry analyze_table_query_plan_request analyze_table_query_plan_response boolean_query boost_query 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_scalar_index_response create_table_tag_request create_table_tag_response declare_table_request declare_table_response delete_from_table_request delete_from_table_response delete_table_tag_request delete_table_tag_response 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 fragment_stats fragment_summary fts_query get_table_stats_request get_table_stats_response get_table_tag_version_request get_table_tag_version_response identity 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_request 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 phrase_query query_table_request query_table_request_columns query_table_request_full_text_query query_table_request_vector register_table_request register_table_response rename_table_request rename_table_response restore_table_request restore_table_response string_fts_query structured_fts_query table_basic_stats table_exists_request table_version tag_contents update_table_request update_table_response update_table_schema_metadata_request update_table_schema_metadata_response update_table_tag_request update_table_tag_response AddVirtualColumnEntry AlterColumnsEntry 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 AlterVirtualColumnEntry 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 CountTableRowsRequest CreateEmptyTableRequest CreateEmptyTableRequest : Request for creating an empty table. Deprecated : Use DeclareTableRequest instead. CreateEmptyTableResponse CreateEmptyTableResponse : Response for creating an empty table. Deprecated : Use DeclareTableResponse instead. CreateNamespaceRequest CreateNamespaceResponse CreateTableIndexRequest CreateTableIndexResponse CreateTableIndexResponse : Response for create index operation CreateTableRequest CreateTableRequest : Request for creating a table, excluding the Arrow IPC stream. CreateTableResponse CreateTableScalarIndexResponse CreateTableScalarIndexResponse : Response for create scalar index operation CreateTableTagRequest CreateTableTagResponse CreateTableTagResponse : Response for create tag operation DeclareTableRequest DeclareTableRequest : Request for declaring a table. DeclareTableResponse DeclareTableResponse : Response for declaring a table. DeleteFromTableRequest DeleteFromTableRequest : Delete data from table based on a SQL predicate. Returns the number of rows that were deleted. DeleteFromTableResponse DeleteTableTagRequest DeleteTableTagResponse DeleteTableTagResponse : Response for delete tag operation DeregisterTableRequest DeregisterTableRequest : The table content remains available in the storage. DeregisterTableResponse DescribeNamespaceRequest DescribeNamespaceResponse DescribeTableIndexStatsRequest DescribeTableIndexStatsResponse DescribeTableRequest DescribeTableResponse DescribeTransactionRequest DescribeTransactionResponse DropNamespaceRequest DropNamespaceResponse DropTableIndexRequest DropTableIndexResponse DropTableIndexResponse : Response for drop index operation 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 FragmentStats FragmentSummary 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 Identity Identity : Identity information of a request. 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 ListTableTagsRequest ListTableTagsResponse ListTableTagsResponse : Response containing table tags 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 QueryTableRequestColumns QueryTableRequestColumns : Optional columns to return. Provide either column_names or column_aliases, not both. 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 RenameTableRequest RenameTableResponse RestoreTableRequest RestoreTableResponse RestoreTableResponse : Response for restore table operation StringFtsQuery StructuredFtsQuery TableBasicStats 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 UpdateTableSchemaMetadataRequest UpdateTableSchemaMetadataResponse UpdateTableTagRequest UpdateTableTagResponse UpdateTableTagResponse : Response for update tag operation