Documentation
¶
Index ¶
- type DBIdentityDTO
- type GreetDTO
- type GreetInput
- type GreetingInput
- type GreetingOutput
- type HierarchyInput
- type ListSchemasInput
- type ListSchemasPageInput
- type ListTablesInput
- type ListTablesPageInput
- type QueryInput
- type QueryJSONInput
- type QueryResultDTO
- type ServerInfoDTO
- type ServerInfoOutput
- type SimpleRowsDTO
- type SimpleTextDTO
- type ValidationResultDTO
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DBIdentityDTO ¶
type DBIdentityDTO struct {
Identity string `json:"identity"`
}
DBIdentityDTO represents the current database identity.
type GreetDTO ¶
type GreetDTO struct {
Greeting string `json:"greeting"`
}
GreetDTO carries a simple greeting payload.
type GreetInput ¶
type GreetInput struct {
Name string `json:"name" jsonschema:"the person to greet"`
}
type GreetingInput ¶
type GreetingInput struct {
Name string `json:"name" jsonschema:"the name of the person to greet"`
}
type GreetingOutput ¶
type GreetingOutput struct {
Greeting string `json:"greeting" jsonschema:"the greeting to tell to the user"`
}
type HierarchyInput ¶
type HierarchyInput struct {
Provider string `json:"provider,omitempty" yaml:"provider,omitempty"`
Service string `json:"service,omitempty" yaml:"service,omitempty"`
Resource string `json:"resource,omitempty" yaml:"resource,omitempty"`
Method string `json:"method,omitempty" yaml:"method,omitempty"`
RowLimit int `json:"row_limit,omitempty" yaml:"row_limit,omitempty"`
Format string `json:"format,omitempty" yaml:"format,omitempty"`
}
type ListSchemasInput ¶
type ListSchemasInput struct {
IncludeSystem bool `json:"include_system,omitempty" yaml:"include_system,omitempty"`
IncludeTemp bool `json:"include_temp,omitempty" yaml:"include_temp,omitempty"`
RequireUsage bool `json:"require_usage,omitempty" yaml:"require_usage,omitempty"`
RowLimit int `json:"row_limit,omitempty" yaml:"row_limit,omitempty"`
NameLike *string `json:"name_like,omitempty" yaml:"name_like,omitempty"`
CaseSensitive bool `json:"case_sensitive,omitempty" yaml:"case_sensitive,omitempty"`
Format string `json:"format,omitempty" yaml:"format,omitempty"`
}
type ListSchemasPageInput ¶
type ListSchemasPageInput struct {
IncludeSystem bool `json:"include_system" yaml:"include_system"`
IncludeTemp bool `json:"include_temp" yaml:"include_temp"`
RequireUsage bool `json:"require_usage" yaml:"require_usage"`
PageSize int `json:"page_size" yaml:"page_size"`
Cursor *string `json:"cursor,omitempty" yaml:"cursor,omitempty"`
NameLike *string `json:"name_like,omitempty" yaml:"name_like,omitempty"`
CaseSensitive bool `json:"case_sensitive" yaml:"case_sensitive"`
Format string `json:"format" yaml:"format"`
}
type ListTablesInput ¶
type ListTablesInput struct {
Hierarchy *HierarchyInput `json:"hierarchy,omitempty" yaml:"hierarchy,omitempty"`
NameLike *string `json:"name_like,omitempty" yaml:"name_like,omitempty"`
CaseSensitive bool `json:"case_sensitive,omitempty" yaml:"case_sensitive,omitempty"`
TableTypes []string `json:"table_types,omitempty" yaml:"table_types,omitempty"`
RowLimit int `json:"row_limit,omitempty" yaml:"row_limit,omitempty"`
Format string `json:"format,omitempty" yaml:"format,omitempty"`
}
type ListTablesPageInput ¶
type ListTablesPageInput struct {
Hierarchy *HierarchyInput `json:"hierarchy,omitempty" yaml:"hierarchy,omitempty"`
NameLike *string `json:"name_like,omitempty" yaml:"name_like,omitempty"`
CaseSensitive bool `json:"case_sensitive,omitempty" yaml:"case_sensitive,omitempty"`
TableTypes []string `json:"table_types,omitempty" yaml:"table_types,omitempty"`
PageSize int `json:"page_size,omitempty" yaml:"page_size,omitempty"`
Cursor *string `json:"cursor,omitempty" yaml:"cursor,omitempty"`
Format string `json:"format,omitempty" yaml:"format,omitempty"`
}
type QueryInput ¶
type QueryJSONInput ¶
type QueryResultDTO ¶
type QueryResultDTO struct {
Rows []map[string]any `json:"rows,omitempty"`
RowCount int `json:"row_count"`
Format string `json:"format"`
Raw string `json:"raw,omitempty"`
Warnings []string `json:"warnings,omitempty"`
}
QueryResultDTO represents a query response; Rows only populated for JSON format. Raw contains original textual result when not parsed; Warnings may include advisory messages (e.g. URL encode slashes in hierarchical resource keys).
type ServerInfoDTO ¶
type ServerInfoOutput ¶
type SimpleRowsDTO ¶
SimpleRowsDTO wraps a plain rows array.
type SimpleTextDTO ¶
type SimpleTextDTO struct {
Text string `json:"text"`
}
SimpleTextDTO wraps a single text payload.
type ValidationResultDTO ¶
Click to show internal directories.
Click to hide internal directories.