gRPC Reference
Complete message reference for ui/proto/lakehouse.proto.
CatalogService
ListTablesRequest
(empty message)
ListTablesResponse
| Field |
Type |
Description |
namespaces |
repeated string |
List of namespace names |
tables |
repeated string |
List of fully qualified table names |
GetSchemaRequest
| Field |
Type |
Description |
table_name |
string |
Fully qualified table name |
ColumnInfo
| Field |
Type |
Description |
name |
string |
Column name |
type |
string |
Spark SQL type |
nullable |
bool |
Whether the column is nullable |
comment |
optional string |
Column comment |
SchemaResponse
| Field |
Type |
Description |
success |
bool |
Operation success |
table |
string |
Table name |
columns |
repeated ColumnInfo |
Column definitions |
error |
optional string |
Error message |
HealthService
GetTableHealthRequest
| Field |
Type |
Description |
table_name |
string |
Fully qualified table name |
TableHealthResponse
| Field |
Type |
Description |
success |
bool |
Operation success |
table |
string |
Table name |
snapshot_count |
int32 |
Number of snapshots |
data_file_count |
int32 |
Number of data files |
total_size_bytes |
int64 |
Total data size |
avg_file_size_bytes |
int64 |
Average file size |
small_file_count |
int32 |
Number of small files |
recommendation |
string |
Maintenance recommendation |
error |
optional string |
Error message |
OperationsService
CompactRequest
| Field |
Type |
Description |
table |
string |
Fully qualified table name |
strategy |
string |
binpack, sort, or zorder |
options |
map<string, string> |
Additional compaction options |
ExpireRequest
| Field |
Type |
Description |
table |
string |
Fully qualified table name |
retain_last |
int32 |
Number of snapshots to retain |
older_than |
optional string |
Expire before this timestamp |
RemoveOrphansRequest
| Field |
Type |
Description |
table |
string |
Fully qualified table name |
dry_run |
bool |
List files without removing |
OperationResponse
| Field |
Type |
Description |
success |
bool |
Operation success |
operation |
string |
Operation name |
table |
string |
Table name |
details_json |
string |
JSON-encoded result details |
error |
optional string |
Error message |
AddColumnRequest
| Field |
Type |
Description |
table |
string |
Fully qualified table name |
name |
string |
New column name |
type |
string |
Spark SQL type |
after |
optional string |
Position after column |
comment |
optional string |
Column comment |
RenameColumnRequest
| Field |
Type |
Description |
table |
string |
Fully qualified table name |
old_name |
string |
Current column name |
new_name |
string |
New column name |
DropColumnRequest
| Field |
Type |
Description |
table |
string |
Fully qualified table name |
name |
string |
Column to drop |
StreamingService
StartPipelineRequest
| Field |
Type |
Description |
source_table |
string |
Source table for streaming |
sink_table |
optional string |
Sink table for output |
checkpoint_location |
optional string |
Checkpoint path |
trigger_interval |
string |
Trigger interval (e.g., "10 seconds") |
StopPipelineRequest
| Field |
Type |
Description |
pipeline_id |
string |
Pipeline to stop |
StopPipelineResponse
| Field |
Type |
Description |
success |
bool |
Operation success |
pipeline_id |
string |
Pipeline ID |
status |
string |
Final status |
error |
optional string |
Error message |
GetPipelineStatusRequest
| Field |
Type |
Description |
pipeline_id |
string |
Pipeline to query |
PipelineStatusResponse
| Field |
Type |
Description |
pipeline_id |
string |
Pipeline ID |
status |
string |
Current status |
batches_processed |
int64 |
Batches completed |
rows_processed |
int64 |
Rows processed |
error |
optional string |
Error message |
ListPipelinesRequest
(empty message)
PipelineInfo
| Field |
Type |
Description |
id |
string |
Pipeline ID |
status |
string |
Current status |
source |
string |
Source table |
ListPipelinesResponse
| Field |
Type |
Description |
pipelines |
repeated PipelineInfo |
All pipelines |
MonitorMetricsRequest
| Field |
Type |
Description |
pipeline_id |
optional string |
Filter by pipeline (all if empty) |
PipelineMetrics (server-streaming)
| Field |
Type |
Description |
pipeline_id |
string |
Pipeline ID |
status |
string |
Current status |
batches_processed |
int64 |
Batches completed |
rows_processed |
int64 |
Rows processed |
AgentService
ChatRequest
| Field |
Type |
Description |
prompt |
string |
Natural language prompt |
provider |
string |
LLM provider |
model |
string |
Model name |
api_base |
optional string |
Custom API endpoint |
| Field |
Type |
Description |
tool |
string |
Tool name |
arguments_json |
string |
JSON-encoded arguments |
result_json |
string |
JSON-encoded result |
ChatResponse
| Field |
Type |
Description |
success |
bool |
Operation success |
response |
string |
Agent response text |
tool_calls |
repeated ToolCallInfo |
Tools invoked |
error |
optional string |
Error message |
ChatStreamEvent (server-streaming)
| Field |
Type |
Description |
event_type |
string |
tool_call, response, error, done |
data_json |
string |
JSON-encoded payload |
ConfigService
GetConfigRequest
(empty message)
ConfigResponse
| Field |
Type |
Description |
configured |
bool |
Whether catalog is configured |
catalog_type |
optional string |
Catalog type |
warehouse |
optional string |
Warehouse path |
catalog_name |
optional string |
Catalog name |
uri |
optional string |
Catalog URI |
extra_props |
map<string, string> |
Additional properties |
SetConfigRequest
| Field |
Type |
Description |
catalog_type |
string |
Catalog type |
warehouse |
string |
Warehouse path |
catalog_name |
string |
Catalog name |
uri |
optional string |
Catalog URI |
extra_props |
map<string, string> |
Additional properties |
SetConfigResponse
| Field |
Type |
Description |
success |
bool |
Operation success |
catalog_type |
optional string |
Applied catalog type |
warehouse |
optional string |
Applied warehouse |
catalog_name |
optional string |
Applied catalog name |
uri |
optional string |
Applied URI |