VgiProtocol API Reference

aggregate_bind unary

Parameters

Name	Type
`request`	`binary`

Returns

Name	Type
`result`	`binary`

aggregate_combine unary

Parameters

Name	Type
`request`	`binary`

Returns

Name	Type
`result`	`binary`

aggregate_destructor unary

Parameters

Name	Type
`request`	`binary`

Returns

Name	Type
`result`	`binary`

aggregate_finalize unary

Parameters

Name	Type
`request`	`binary`

Returns

Name	Type
`result`	`binary`

aggregate_streaming_chunk unary

Parameters

Name	Type
`request`	`binary`

Returns

Name	Type
`result`	`binary`

aggregate_streaming_close unary

Parameters

Name	Type
`request`	`binary`

Returns

Name	Type
`result`	`binary`

aggregate_streaming_open unary

Parameters

Name	Type
`request`	`binary`

Returns

Name	Type
`result`	`binary`

aggregate_update unary

Parameters

Name	Type
`request`	`binary`

Returns

Name	Type
`result`	`binary`

aggregate_window unary

Parameters

Name	Type
`request`	`binary`

Returns

Name	Type
`result`	`binary`

aggregate_window_batch unary

Parameters

Name	Type
`request`	`binary`

Returns

Name	Type
`result`	`binary`

aggregate_window_destructor unary

Parameters

Name	Type
`request`	`binary`

Returns

Name	Type
`result`	`binary`

aggregate_window_init unary

Parameters

Name	Type
`request`	`binary`

Returns

Name	Type
`result`	`binary`

bind unary

Parameters

Name	Type
`request`	`binary`

Returns

Name	Type
`result`	`binary`

catalog_attach unary

Parameters

Name	Type
`request`	`binary`

Returns

Name	Type
`result`	`binary`

catalog_catalogs unary

No parameters

Returns

Name	Type
`result`	`binary`

catalog_create unary

Parameters

Name	Type
`request`	`binary`

catalog_detach unary

Parameters

Name	Type
`attach_opaque_data`	`binary`

catalog_drop unary

Parameters

Name	Type
`name`	`string`

catalog_index_create unary

Parameters

Name	Type
`request`	`binary`

catalog_index_drop unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`ignore_not_found`	`bool`
`cascade`	`bool`
`transaction_opaque_data`	`binary`

catalog_index_get unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`transaction_opaque_data`	`binary`

Returns

Name	Type
`result`	`binary`

catalog_macro_create unary

Parameters

Name	Type
`request`	`binary`

catalog_macro_drop unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`ignore_not_found`	`bool`
`transaction_opaque_data`	`binary`

catalog_macro_get unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`transaction_opaque_data`	`binary`

Returns

Name	Type
`result`	`binary`

catalog_schema_contents_functions unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`name`	`string`
`type`	`dictionary<values=string, indices=int16, ordered=0>`
`transaction_opaque_data`	`binary`

Returns

Name	Type
`result`	`binary`

catalog_schema_contents_indexes unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`name`	`string`
`transaction_opaque_data`	`binary`

Returns

Name	Type
`result`	`binary`

catalog_schema_contents_macros unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`name`	`string`
`type`	`dictionary<values=string, indices=int16, ordered=0>`
`transaction_opaque_data`	`binary`

Returns

Name	Type
`result`	`binary`

catalog_schema_contents_tables unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`name`	`string`
`transaction_opaque_data`	`binary`

Returns

Name	Type
`result`	`binary`

catalog_schema_contents_views unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`name`	`string`
`transaction_opaque_data`	`binary`

Returns

Name	Type
`result`	`binary`

catalog_schema_create unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`name`	`string`
`on_conflict`	`dictionary<values=string, indices=int16, ordered=0>`
`comment`	`string`
`tags`	`map<string, string>`
`transaction_opaque_data`	`binary`

catalog_schema_drop unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`name`	`string`
`ignore_not_found`	`bool`
`cascade`	`bool`
`transaction_opaque_data`	`binary`

catalog_schema_get unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`name`	`string`
`transaction_opaque_data`	`binary`

Returns

Name	Type
`result`	`binary`

catalog_schemas unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`transaction_opaque_data`	`binary`

Returns

Name	Type
`result`	`binary`

catalog_table_column_add unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`column_definition`	`binary`
`ignore_not_found`	`bool`
`if_column_not_exists`	`bool`
`transaction_opaque_data`	`binary`

catalog_table_column_comment_set unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`column_name`	`string`
`comment`	`string`
`ignore_not_found`	`bool`
`transaction_opaque_data`	`binary`

catalog_table_column_default_drop unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`column_name`	`string`
`ignore_not_found`	`bool`
`transaction_opaque_data`	`binary`

catalog_table_column_default_set unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`column_name`	`string`
`expression`	`string`
`ignore_not_found`	`bool`
`transaction_opaque_data`	`binary`

catalog_table_column_drop unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`column_name`	`string`
`ignore_not_found`	`bool`
`if_column_exists`	`bool`
`cascade`	`bool`
`transaction_opaque_data`	`binary`

catalog_table_column_rename unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`column_name`	`string`
`new_column_name`	`string`
`ignore_not_found`	`bool`
`transaction_opaque_data`	`binary`

catalog_table_column_statistics_get unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`transaction_opaque_data`	`binary`

Returns

Name	Type
`result`	`binary`

catalog_table_column_type_change unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`column_definition`	`binary`
`expression`	`string`
`ignore_not_found`	`bool`
`transaction_opaque_data`	`binary`

catalog_table_comment_set unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`comment`	`string`
`ignore_not_found`	`bool`
`transaction_opaque_data`	`binary`

catalog_table_create unary

Parameters

Name	Type
`request`	`binary`

catalog_table_delete_function_get unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`transaction_opaque_data`	`binary`

Returns

Name	Type
`result`	`binary`

catalog_table_drop unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`ignore_not_found`	`bool`
`cascade`	`bool`
`transaction_opaque_data`	`binary`

catalog_table_get unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`at_unit`	`string`
`at_value`	`string`
`transaction_opaque_data`	`binary`

Returns

Name	Type
`result`	`binary`

catalog_table_insert_function_get unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`transaction_opaque_data`	`binary`
`writable_branch_function_name`	`string`

Returns

Name	Type
`result`	`binary`

catalog_table_not_null_drop unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`column_name`	`string`
`ignore_not_found`	`bool`
`transaction_opaque_data`	`binary`

catalog_table_not_null_set unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`column_name`	`string`
`ignore_not_found`	`bool`
`transaction_opaque_data`	`binary`

catalog_table_rename unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`new_name`	`string`
`ignore_not_found`	`bool`
`transaction_opaque_data`	`binary`

catalog_table_scan_branches_get unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`at_unit`	`string`
`at_value`	`string`
`transaction_opaque_data`	`binary`

Returns

Name	Type
`result`	`binary`

catalog_table_scan_function_get unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`at_unit`	`string`
`at_value`	`string`
`transaction_opaque_data`	`binary`

Returns

Name	Type
`result`	`binary`

catalog_table_update_function_get unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`transaction_opaque_data`	`binary`

Returns

Name	Type
`result`	`binary`

catalog_transaction_begin unary

Parameters

Name	Type
`attach_opaque_data`	`binary`

Returns

Name	Type
`result`	`binary`

catalog_transaction_commit unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`transaction_opaque_data`	`binary`

catalog_transaction_rollback unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`transaction_opaque_data`	`binary`

catalog_version unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`transaction_opaque_data`	`binary`

Returns

Name	Type
`result`	`binary`

catalog_view_comment_set unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`comment`	`string`
`ignore_not_found`	`bool`
`transaction_opaque_data`	`binary`

catalog_view_create unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`definition`	`string`
`on_conflict`	`dictionary<values=string, indices=int16, ordered=0>`
`transaction_opaque_data`	`binary`

catalog_view_drop unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`ignore_not_found`	`bool`
`cascade`	`bool`
`transaction_opaque_data`	`binary`

catalog_view_get unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`transaction_opaque_data`	`binary`

Returns

Name	Type
`result`	`binary`

catalog_view_rename unary

Parameters

Name	Type
`attach_opaque_data`	`binary`
`schema_name`	`string`
`name`	`string`
`new_name`	`string`
`ignore_not_found`	`bool`
`transaction_opaque_data`	`binary`

init stream header

Parameters

Name	Type
`request`	`binary`

Stream Header

Name	Type
`execution_id`	`binary`
`opaque_data`	`binary`
`max_workers`	`int64`

table_buffering_combine unary

Parameters

Name	Type
`request`	`binary`

Returns

Name	Type
`result`	`binary`

table_buffering_destructor unary

Parameters

Name	Type
`request`	`binary`

Returns

Name	Type
`result`	`binary`

table_buffering_process unary

Parameters

Name	Type
`request`	`binary`

Returns

Name	Type
`result`	`binary`

table_function_cardinality unary

Parameters

Name	Type
`request`	`binary`

Returns

Name	Type
`result`	`binary`

table_function_dynamic_to_string unary

Parameters

Name	Type
`request`	`binary`

Returns

Name	Type
`result`	`binary`

table_function_statistics unary

Parameters

Name	Type
`request`	`binary`

Returns

Name	Type
`result`	`binary`