@query-farm/vgi 0.6.0

package/src/generated/vgi-client.ts

@@ -0,0 +1,560 @@
+// ============================================================================
+// GENERATED by vgi.codegen.ts_client. DO NOT EDIT BY HAND.
+//
+// Generator: vgi-gen-ts-client v1
+// Content hash: 101207be9452
+//
+// To regenerate:
+//   uv run --project ~/Development/vgi-python vgi-gen-ts-client \
+//     > ~/Development/vgi-typescript/src/generated/vgi-client.ts
+// ============================================================================
+
+import { encodeASD, decodeASD } from "../codec/asd.js";
+import {
+  CatalogInfoSchema,
+  FunctionInfoSchema,
+  IndexInfoSchema,
+  MacroInfoSchema,
+  SchemaInfoSchema,
+  TableInfoSchema,
+  ViewInfoSchema,
+} from "./vgi-protocol-schemas.js";
+
+export type DistinctDependence = "DISTINCT_DEPENDENT" | "NOT_DISTINCT_DEPENDENT";
+export type FunctionStability = "CONSISTENT" | "VOLATILE" | "CONSISTENT_WITHIN_QUERY";
+export type FunctionType = "SCALAR" | "TABLE" | "TABLE_BUFFERING" | "AGGREGATE";
+export type IndexConstraintType = "NONE" | "UNIQUE" | "PRIMARY";
+export type InvocationFunctionType = "AGGREGATE" | "SCALAR" | "TABLE" | "TABLE_BUFFERING";
+export type MacroType = "SCALAR" | "TABLE";
+export type NullHandling = "DEFAULT" | "SPECIAL";
+export type OnConflict = "ERROR" | "IGNORE" | "REPLACE";
+export type OrderByDirection = "ASC" | "DESC";
+export type OrderByNullOrder = "NULLS_FIRST" | "NULLS_LAST";
+export type OrderDependence = "ORDER_DEPENDENT" | "NOT_ORDER_DEPENDENT";
+export type OrderPreservation = "PRESERVES_ORDER" | "NO_ORDER_GUARANTEE" | "FIXED_ORDER";
+export type PartitionKind = "NOT_PARTITIONED" | "SINGLE_VALUE_PARTITIONS" | "OVERLAPPING_PARTITIONS" | "DISJOINT_PARTITIONS";
+export type SchemaObjectType = "TABLE" | "VIEW" | "SCALAR_FUNCTION" | "TABLE_FUNCTION" | "AGGREGATE_FUNCTION" | "SCALAR_MACRO" | "TABLE_MACRO" | "INDEX";
+export type TableInOutFunctionInitPhase = "INPUT" | "FINALIZE" | "TABLE_BUFFERING" | "TABLE_BUFFERING_FINALIZE";
+
+export interface CatalogDataVersionRelease {
+  version: string;
+  released_at?: bigint | null;
+  summary: string;
+  notes_url?: string | null;
+}
+
+export interface CatalogInfo {
+  name: string;
+  implementation_version?: string | null;
+  data_version_spec?: string | null;
+  attach_option_specs: Uint8Array[];
+  releases: CatalogDataVersionRelease[];
+  source_url?: string | null;
+}
+
+export interface SchemaInfo {
+  comment?: string | null;
+  tags: Record<string, string>;
+  attach_opaque_data: Uint8Array;
+  name: string;
+  estimated_object_count?: Record<string, number> | null;
+}
+
+export interface TableInfo {
+  comment?: string | null;
+  tags: Record<string, string>;
+  name: string;
+  schema_name: string;
+  columns: Uint8Array;
+  not_null_constraints: number[];
+  unique_constraints: number[][];
+  check_constraints: string[];
+  primary_key_constraints: number[][];
+  foreign_key_constraints: Uint8Array[];
+  supports_insert: boolean;
+  supports_update: boolean;
+  supports_delete: boolean;
+  supports_returning: boolean;
+  supports_column_statistics: boolean;
+  scan_function?: Uint8Array | null;
+  insert_function?: Uint8Array | null;
+  update_function?: Uint8Array | null;
+  delete_function?: Uint8Array | null;
+  cardinality_estimate?: number | null;
+  cardinality_max?: number | null;
+  column_statistics?: Uint8Array | null;
+  bind_result?: Uint8Array | null;
+  required_field_filter_paths: string[];
+}
+
+export interface ViewInfo {
+  comment?: string | null;
+  tags: Record<string, string>;
+  name: string;
+  schema_name: string;
+  definition: string;
+  column_comments: Record<string, string>;
+}
+
+export interface CatalogExample {
+  sql: string;
+  description: string;
+  expected_output?: string | null;
+}
+
+export interface SecretLookupEntry {
+  secret_type: string;
+  scope?: string | null;
+  secret_name?: string | null;
+}
+
+export interface FunctionInfo {
+  comment?: string | null;
+  tags: Record<string, string>;
+  name: string;
+  schema_name: string;
+  function_type: FunctionType;
+  arguments: Uint8Array;
+  output_schema: Uint8Array;
+  stability?: FunctionStability | null;
+  null_handling?: NullHandling | null;
+  description: string;
+  examples: CatalogExample[];
+  categories: string[];
+  projection_pushdown?: boolean | null;
+  filter_pushdown?: boolean | null;
+  sampling_pushdown?: boolean | null;
+  late_materialization?: boolean | null;
+  supported_expression_filters: string[];
+  order_preservation?: OrderPreservation | null;
+  max_workers?: number | null;
+  supports_batch_index: boolean;
+  partition_kind: PartitionKind;
+  order_dependent: OrderDependence;
+  distinct_dependent: DistinctDependence;
+  supports_window: boolean;
+  streaming_partitioned: boolean;
+  has_finalize: boolean;
+  source_order_dependent: boolean;
+  sink_order_dependent: boolean;
+  requires_input_batch_index: boolean;
+  required_settings: string[];
+  required_secrets: SecretLookupEntry[];
+}
+
+export interface MacroInfo {
+  comment?: string | null;
+  tags: Record<string, string>;
+  name: string;
+  schema_name: string;
+  macro_type: MacroType;
+  parameters: string[];
+  parameter_default_values?: /** @record-batch */ Uint8Array | null;
+  definition: string;
+  arguments_schema?: /** @arrow-schema */ Uint8Array | null;
+}
+
+export interface IndexInfo {
+  comment?: string | null;
+  tags: Record<string, string>;
+  name: string;
+  schema_name: string;
+  table_name: string;
+  index_type: string;
+  constraint_type: IndexConstraintType;
+  expressions: string[];
+  options: Record<string, string>;
+}
+
+export interface AggregateBindRequest {
+  function_name: string;
+  arguments: /** @vgi-arguments */ Uint8Array;
+  input_schema?: /** @arrow-schema */ Uint8Array | null;
+  settings?: /** @record-batch */ Uint8Array | null;
+  secrets?: /** @record-batch */ Uint8Array | null;
+  attach_opaque_data?: Uint8Array | null;
+}
+
+export interface AggregateBindResponse {
+  output_schema: /** @arrow-schema */ Uint8Array;
+  execution_id: Uint8Array;
+}
+
+export interface AggregateCombineRequest {
+  function_name: string;
+  execution_id: Uint8Array;
+  merge_batch: Uint8Array;
+  attach_opaque_data?: Uint8Array | null;
+}
+
+export interface AggregateCombineResponse {
+}
+
+export interface AggregateDestructorRequest {
+  function_name: string;
+  execution_id: Uint8Array;
+  group_ids_batch: Uint8Array;
+  attach_opaque_data?: Uint8Array | null;
+}
+
+export interface AggregateDestructorResponse {
+}
+
+export interface AggregateFinalizeRequest {
+  function_name: string;
+  execution_id: Uint8Array;
+  group_ids_batch: Uint8Array;
+  output_schema: /** @arrow-schema */ Uint8Array;
+  attach_opaque_data?: Uint8Array | null;
+}
+
+export interface AggregateFinalizeResponse {
+  result_batch: Uint8Array;
+}
+
+export interface AggregateStreamingChunkRequest {
+  function_name: string;
+  execution_id: Uint8Array;
+  input_batch: Uint8Array;
+  attach_opaque_data?: Uint8Array | null;
+}
+
+export interface AggregateStreamingChunkResponse {
+  result_batch: Uint8Array;
+}
+
+export interface AggregateStreamingCloseRequest {
+  function_name: string;
+  execution_id: Uint8Array;
+  attach_opaque_data?: Uint8Array | null;
+}
+
+export interface AggregateStreamingCloseResponse {
+}
+
+export interface AggregateStreamingOpenRequest {
+  function_name: string;
+  arguments: /** @vgi-arguments */ Uint8Array;
+  input_schema: /** @arrow-schema */ Uint8Array;
+  partition_key_count: number;
+  order_key_count: number;
+  output_schema: /** @arrow-schema */ Uint8Array;
+  settings?: /** @record-batch */ Uint8Array | null;
+  secrets?: /** @record-batch */ Uint8Array | null;
+  attach_opaque_data?: Uint8Array | null;
+}
+
+export interface AggregateStreamingOpenResponse {
+  execution_id: Uint8Array;
+}
+
+export interface AggregateUpdateRequest {
+  function_name: string;
+  execution_id: Uint8Array;
+  input_batch: Uint8Array;
+  attach_opaque_data?: Uint8Array | null;
+}
+
+export interface AggregateUpdateResponse {
+}
+
+export interface AggregateWindowRequest {
+  function_name: string;
+  execution_id: Uint8Array;
+  partition_id: number;
+  rid: number;
+  frame_starts: number[];
+  frame_ends: number[];
+  attach_opaque_data?: Uint8Array | null;
+}
+
+export interface AggregateWindowResponse {
+  result_batch: Uint8Array;
+}
+
+export interface AggregateWindowBatchRequest {
+  function_name: string;
+  execution_id: Uint8Array;
+  partition_id: number;
+  row_idx: number;
+  count: number;
+  frames_per_row: number[];
+  frame_starts: number[];
+  frame_ends: number[];
+  attach_opaque_data?: Uint8Array | null;
+}
+
+export interface AggregateWindowBatchResponse {
+  result_batch: Uint8Array;
+}
+
+export interface AggregateWindowDestructorRequest {
+  function_name: string;
+  execution_id: Uint8Array;
+  partition_id: number;
+  attach_opaque_data?: Uint8Array | null;
+}
+
+export interface AggregateWindowDestructorResponse {
+}
+
+export interface AggregateWindowInitRequest {
+  function_name: string;
+  execution_id: Uint8Array;
+  partition_id: number;
+  row_count: number;
+  partition_batch: Uint8Array;
+  output_schema: /** @arrow-schema */ Uint8Array;
+  filter_mask: Uint8Array;
+  frame_stats: Uint8Array;
+  all_valid: Uint8Array;
+  attach_opaque_data?: Uint8Array | null;
+}
+
+export interface AggregateWindowInitResponse {
+}
+
+export interface CopyFromContext {
+  format: string;
+  file_path: string;
+  expected_schema: /** @arrow-schema */ Uint8Array;
+}
+
+export interface CopyToContext {
+  format: string;
+  file_path: string;
+}
+
+export interface BindRequest {
+  function_name: string;
+  arguments: /** @vgi-arguments */ Uint8Array;
+  function_type: InvocationFunctionType;
+  input_schema?: /** @arrow-schema */ Uint8Array | null;
+  settings?: /** @record-batch */ Uint8Array | null;
+  secrets?: /** @record-batch */ Uint8Array | null;
+  attach_opaque_data?: Uint8Array | null;
+  transaction_opaque_data?: Uint8Array | null;
+  resolved_secrets_provided: boolean;
+  at_unit?: string | null;
+  at_value?: string | null;
+  copy_from?: CopyFromContext | null;
+  copy_to?: CopyToContext | null;
+}
+
+export interface BindResponse {
+  output_schema: /** @arrow-schema */ Uint8Array;
+  opaque_data?: Uint8Array | null;
+  lookup_secret_types: string[];
+  lookup_scopes: string[];
+  lookup_names: string[];
+}
+
+export interface CatalogAttachRequest {
+  name: string;
+  options?: /** @record-batch */ Uint8Array | null;
+  data_version_spec?: string | null;
+  implementation_version?: string | null;
+}
+
+export interface CatalogAttachResult {
+  attach_opaque_data: Uint8Array;
+  supports_transactions: boolean;
+  supports_time_travel: boolean;
+  catalog_version_frozen: boolean;
+  catalog_version: number;
+  attach_opaque_data_required: boolean;
+  default_schema: string;
+  settings: Uint8Array[];
+  secret_types: Uint8Array[];
+  comment?: string | null;
+  tags: Record<string, string>;
+  supports_column_statistics: boolean;
+  resolved_data_version?: string | null;
+  resolved_implementation_version?: string | null;
+}
+
+export interface CatalogsResponse {
+  items: CatalogInfo[];
+}
+
+export interface CopyFromFormatsResponse {
+  items: Uint8Array[];
+}
+
+export interface CatalogCreateRequest {
+  name: string;
+  on_conflict: OnConflict;
+  options?: /** @record-batch */ Uint8Array | null;
+}
+
+export interface IndexCreateRequest {
+  attach_opaque_data: Uint8Array;
+  schema_name: string;
+  name: string;
+  table_name: string;
+  index_type: string;
+  constraint_type: IndexConstraintType;
+  expressions: string[];
+  on_conflict: OnConflict;
+  options: Record<string, string>;
+  transaction_opaque_data?: Uint8Array | null;
+}
+
+export interface IndexesResponse {
+  items: IndexInfo[];
+}
+
+export interface MacroCreateRequest {
+  attach_opaque_data: Uint8Array;
+  schema_name: string;
+  name: string;
+  macro_type: MacroType;
+  parameters: string[];
+  definition: string;
+  on_conflict: OnConflict;
+  parameter_default_values?: /** @record-batch */ Uint8Array | null;
+  arguments_schema?: /** @arrow-schema */ Uint8Array | null;
+  transaction_opaque_data?: Uint8Array | null;
+}
+
+export interface MacrosResponse {
+  items: MacroInfo[];
+}
+
+export interface FunctionsResponse {
+  items: FunctionInfo[];
+}
+
+export interface TablesResponse {
+  items: TableInfo[];
+}
+
+export interface ViewsResponse {
+  items: ViewInfo[];
+}
+
+export interface SchemasResponse {
+  items: SchemaInfo[];
+}
+
+export interface TableCreateRequest {
+  attach_opaque_data: Uint8Array;
+  schema_name: string;
+  name: string;
+  columns: Uint8Array;
+  on_conflict: OnConflict;
+  not_null_constraints: number[];
+  unique_constraints: number[][];
+  check_constraints: string[];
+  primary_key_constraints: number[][];
+  foreign_key_constraints: Uint8Array[];
+  transaction_opaque_data?: Uint8Array | null;
+}
+
+export interface TransactionBeginResponse {
+  transaction_opaque_data?: Uint8Array | null;
+}
+
+export interface CatalogVersionResponse {
+  version: number;
+}
+
+export interface InitRequest {
+  bind_call: BindRequest;
+  output_schema: /** @arrow-schema */ Uint8Array;
+  bind_opaque_data?: Uint8Array | null;
+  projection_ids?: number[] | null;
+  pushdown_filters?: /** @record-batch */ Uint8Array | null;
+  join_keys?: /** @record-batch */ Uint8Array[] | null;
+  phase?: TableInOutFunctionInitPhase | null;
+  finalize_state_id?: Uint8Array | null;
+  execution_id?: Uint8Array | null;
+  init_opaque_data?: Uint8Array | null;
+  order_by_column_name?: string | null;
+  order_by_direction?: OrderByDirection | null;
+  order_by_null_order?: OrderByNullOrder | null;
+  order_by_limit?: number | null;
+  tablesample_percentage?: number | null;
+  tablesample_seed?: number | null;
+}
+
+export interface TableBufferingCombineRequest {
+  function_name: string;
+  execution_id: Uint8Array;
+  state_ids: Uint8Array[];
+  attach_opaque_data?: Uint8Array | null;
+  transaction_id?: Uint8Array | null;
+}
+
+export interface TableBufferingCombineResponse {
+  finalize_state_ids: Uint8Array[];
+}
+
+export interface TableBufferingDestructorRequest {
+  function_name: string;
+  execution_id: Uint8Array;
+  attach_opaque_data?: Uint8Array | null;
+  transaction_id?: Uint8Array | null;
+}
+
+export interface TableBufferingDestructorResponse {
+}
+
+export interface TableBufferingProcessRequest {
+  function_name: string;
+  execution_id: Uint8Array;
+  input_batch: Uint8Array;
+  attach_opaque_data?: Uint8Array | null;
+  transaction_id?: Uint8Array | null;
+  batch_index?: number | null;
+}
+
+export interface TableBufferingProcessResponse {
+  state_id: Uint8Array;
+}
+
+export interface TableFunctionCardinalityRequest {
+  bind_call: BindRequest;
+  bind_opaque_data?: Uint8Array | null;
+}
+
+export interface TableCardinality {
+  estimate?: number | null;
+  max?: number | null;
+}
+
+export interface TableFunctionDynamicToStringRequest {
+  bind_call: BindRequest;
+  bind_opaque_data?: Uint8Array | null;
+  global_execution_id: Uint8Array;
+}
+
+export interface TableFunctionDynamicToStringResponse {
+  keys: string[];
+  values: string[];
+}
+
+export interface TableFunctionStatisticsRequest {
+  bind_call: BindRequest;
+  bind_opaque_data?: Uint8Array | null;
+}
+
+// ----------------------------------------------------------------------------
+// Codec wrappers: turn the typed interfaces above into actual wire bytes.
+// ----------------------------------------------------------------------------
+
+export const encodeCatalogInfo = (v: CatalogInfo): Uint8Array => encodeASD(CatalogInfoSchema, v);
+export const decodeCatalogInfo = (b: Uint8Array): CatalogInfo => decodeASD<CatalogInfo>(CatalogInfoSchema, b);
+export const encodeFunctionInfo = (v: FunctionInfo): Uint8Array => encodeASD(FunctionInfoSchema, v);
+export const decodeFunctionInfo = (b: Uint8Array): FunctionInfo => decodeASD<FunctionInfo>(FunctionInfoSchema, b);
+export const encodeIndexInfo = (v: IndexInfo): Uint8Array => encodeASD(IndexInfoSchema, v);
+export const decodeIndexInfo = (b: Uint8Array): IndexInfo => decodeASD<IndexInfo>(IndexInfoSchema, b);
+export const encodeMacroInfo = (v: MacroInfo): Uint8Array => encodeASD(MacroInfoSchema, v);
+export const decodeMacroInfo = (b: Uint8Array): MacroInfo => decodeASD<MacroInfo>(MacroInfoSchema, b);
+export const encodeSchemaInfo = (v: SchemaInfo): Uint8Array => encodeASD(SchemaInfoSchema, v);
+export const decodeSchemaInfo = (b: Uint8Array): SchemaInfo => decodeASD<SchemaInfo>(SchemaInfoSchema, b);
+export const encodeTableInfo = (v: TableInfo): Uint8Array => encodeASD(TableInfoSchema, v);
+export const decodeTableInfo = (b: Uint8Array): TableInfo => decodeASD<TableInfo>(TableInfoSchema, b);
+export const encodeViewInfo = (v: ViewInfo): Uint8Array => encodeASD(ViewInfoSchema, v);
+export const decodeViewInfo = (b: Uint8Array): ViewInfo => decodeASD<ViewInfo>(ViewInfoSchema, b);
+