queryresults

type Collector struct {
	// contains filtered or unexported fields
}

type Column struct {
	Name          string        `json:"name"`
	Type          string        `json:"type"`
	DeclaredType  *string       `json:"declaredType"`
	Nullable      *bool         `json:"nullable"`
	PK            *int          `json:"pk"`
	Source        *ColumnSource `json:"source"`
	ForeignKeys   []ColumnFK    `json:"foreignKeys"`
	Encoding      string        `json:"encoding,omitempty"`
	CutCells      int           `json:"cutCells,omitempty"`
	ObservedTypes []string      `json:"observedTypes,omitempty"`
	// Internal marks a column that is bookkeeping, not a field of the result
	// (today only the record key "$key"): a consumer that shows fields hides
	// it. It is additive: absent (false) in results written before it
	// existed, which is why IsInternal also knows the key column by name.
	Internal bool `json:"internal,omitempty"`
}

type ColumnFK struct {
	RefSchema   string `json:"refSchema"`
	RefRelation string `json:"refRelation"`
	RefColumn   string `json:"refColumn"`
}

type ColumnFacts struct {
	DeclaredType string
	// ContractType is the declared type in the contract's closed set, or "".
	ContractType string
	Nullable     bool
	PK           int // 1-based position in the primary key, 0 when not in it
	Source       ColumnSource
	ForeignKeys  []ColumnFK
}

type ColumnSource struct {
	Instance string `json:"instance"`
	Schema   string `json:"schema"`
	Relation string `json:"relation"`
	Column   string `json:"column"`
}

type DB struct {
	// Ref is datatug://<project>/<db>?env=<env>, or nil when the database is
	// not a source of a registered project.
	Ref     *string `json:"ref"`
	Project *string `json:"project"`
	Env     *string `json:"env"`
	Source  *string `json:"source"`
	Driver  string  `json:"driver"`
}

type Data struct {
	Anonymous bool
	Bytes     []byte
	Columns   []Column
	Rows      Rows
}

type Error struct{ Reason string }

type JoinPair struct {
	Left  string `json:"left"`
	Right string `json:"right"`
}

type Loaded struct {
	Anonymous bool
	Meta      Meta
	Recordset apicontract.Recordset
	// MetaJSON and DataJSON are the files as they were read.
	MetaJSON, DataJSON []byte
}

type Locator struct {
	Version int    `json:"version"`
	ID      string `json:"id"`
	Root    string `json:"root"`
	Data    string `json:"data"`
	Meta    string `json:"meta"`
}

type Meta struct {
	Anonymous  bool        `json:"anonymous,omitempty"`
	Format     string      `json:"format"`
	Version    int         `json:"version"`
	ID         string      `json:"id"`
	CreatedAt  time.Time   `json:"createdAt"`
	ExpiresAt  time.Time   `json:"expiresAt"`
	CLIVersion string      `json:"cliVersion"`
	DataBytes  int64       `json:"dataBytes"`
	DB         DB          `json:"db"`
	Query      Query       `json:"query"`
	Rows       Rows        `json:"rows"`
	Provenance *Provenance `json:"provenance"`
	Columns    []Column    `json:"columns"`
	// Participants are the query's source occurrences and Related the tables
	// that can be joined to them.
	Participants []Participant `json:"participants"`
	Related      []Related     `json:"related"`
	// Unavailable names, per part, why it is missing or cut short.
	Unavailable Unavailable `json:"unavailable"`
	// Prompt is the request that produced the result, set by `query results
	// annotate`; absent until then and in results written before it existed.
	Prompt *Prompt `json:"prompt,omitempty"`
}

type Participant struct {
	Instance string           `json:"instance"`
	Schema   string           `json:"schema"`
	Relation string           `json:"relation"`
	Alias    string           `json:"alias"`
	DB       *string          `json:"db,omitempty"`
	Kind     string           `json:"kind"`
	Role     string           `json:"role"`
	Join     *ParticipantJoin `json:"join,omitempty"`
}

type ParticipantJoin struct {
	Type string     `json:"type"`
	On   []JoinPair `json:"on"`
}

type Prompt struct {
	Text      string `json:"text"`
	Truncated bool   `json:"truncated"`
	// At is when it was recorded, RFC 3339 in UTC.
	At string `json:"at"`
}

type Provenance struct {
	Mode       string `json:"mode"`
	ObservedAt string `json:"observedAt"`
}

type Query struct {
	Kind           string                                 `json:"kind"`
	TugQL          string                                 `json:"tugql,omitempty"`
	From           string                                 `json:"from,omitempty"`
	SavedQueryID   string                                 `json:"savedQueryId,omitempty"`
	SavedQueryType string                                 `json:"savedQueryType,omitempty"`
	Parameters     map[string]apicontract.TypedValueOrSet `json:"parameters,omitempty"`
	Policy         string                                 `json:"policy"`
	// Text, Language, DBRef and Params make the query openable in the query
	// editor: the canonical text the editor accepts, its language ("tugql",
	// "sql" or "http"), the datatug:// reference of the database (absent when
	// the run was not against a project source) and the run's parameters as
	// name/value pairs. They are additive: readers that predate them ignore
	// them and results written before them lack them.
	Text     string       `json:"text,omitempty"`
	Language string       `json:"language,omitempty"`
	DBRef    string       `json:"dbRef,omitempty"`
	Params   []QueryParam `json:"params,omitempty"`
}

type QueryParam struct {
	Name  string                      `json:"name"`
	Value apicontract.TypedValueOrSet `json:"value"`
}

type Related struct {
	CandidateID  string         `json:"candidateId"`
	FromInstance string         `json:"fromInstance"`
	Target       RelatedTarget  `json:"target"`
	ConstraintID string         `json:"constraintId"`
	Direction    string         `json:"direction"`
	Cardinality  string         `json:"cardinality"`
	Fields       []RelatedField `json:"fields"`
	Evidence     string         `json:"evidence"`
}

type RelatedField struct {
	SourceField string `json:"sourceField"`
	TargetField string `json:"targetField"`
}

type RelatedTarget struct {
	Schema   string `json:"schema"`
	Relation string `json:"relation"`
	Kind     string `json:"kind"`
}

type Result struct {
	// contains filtered or unexported fields
}

type Rows struct {
	Kept        int    `json:"kept"`
	HasMore     bool   `json:"hasMore"`
	TruncatedBy string `json:"truncatedBy"`
}

type Store struct {
	// contains filtered or unexported fields
}

type Unavailable struct {
	Query string `json:"query,omitempty"`
	// Editor says query.text and query.params were dropped for size, so a
	// consumer can tell dropped from absent; the legacy tugql and parameters
	// are untouched by it.
	Editor        string `json:"editor,omitempty"`
	Columns       string `json:"columns,omitempty"`
	Participants  string `json:"participants,omitempty"`
	Related       string `json:"related,omitempty"`
	DeclaredTypes string `json:"declaredTypes,omitempty"`
}