Help us shape the future of Go! Take the 2026 Go Developer Survey

dto

package
v0.10.421 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 6, 2026 License: MIT Imports: 0 Imported by: 0

Documentation

Index

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 QueryInput struct {
	SQL      string `json:"sql" yaml:"sql"`
	RowLimit int    `json:"row_limit,omitempty" yaml:"row_limit,omitempty"`
	Format   string `json:"format,omitempty" yaml:"format,omitempty"`
}

type QueryJSONInput

type QueryJSONInput struct {
	SQL      string `json:"sql" yaml:"sql"`
	RowLimit int    `json:"row_limit,omitempty" yaml:"row_limit,omitempty"`
}

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 ServerInfoDTO struct {
	Name       string `json:"name"`
	Info       string `json:"info"`
	IsReadOnly bool   `json:"is_read_only"`
}

type ServerInfoOutput

type ServerInfoOutput struct {
	Name       string `json:"name" jsonschema:"server name"`
	Info       string `json:"info" jsonschema:"server info"`
	IsReadOnly bool   `json:"is_read_only" jsonschema:"is the database read-only"`
}

type SimpleRowsDTO

type SimpleRowsDTO struct {
	Rows []map[string]any `json:"rows"`
}

SimpleRowsDTO wraps a plain rows array.

type SimpleTextDTO

type SimpleTextDTO struct {
	Text string `json:"text"`
}

SimpleTextDTO wraps a single text payload.

type ValidationResultDTO

type ValidationResultDTO struct {
	IsValid bool     `json:"valid"`
	Message string   `json:"message,omitempty"`
	Errors  []string `json:"errors,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL