database

type AmbiguousFunctionError struct {
	Hint string
	// contains filtered or unexported fields
}

type Argument struct {
	Name   string
	Type   string
	Mode   byte   // i IN, o OUT, b INOUT, v VARIADIC, t TABLE
	TypeId uint32 // OID of the argument type
}

type BinarySerializer struct {
	bytes.Buffer
}

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

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

type CSVSerializer struct {
	TextBuilder
}

type Column struct {
	Name        string   `json:"name"`
	Type        string   `json:"type"`
	NotNull     bool     `json:"notnull"`
	Default     *string  `json:"default"`
	Generated   string   `json:"generated,omitempty"` // "stored" or "virtual" (PostgreSQL 18) for a GENERATED ALWAYS AS column
	ReadOnly    bool     `json:"readonly"`            // a generated column has no default and cannot be written
	Comment     *string  `json:"comment"`
	Constraints []string `json:"constraints"`
	Table       string   `json:"table,omitempty"`
	Schema      string   `json:"schema,omitempty"`
}

type ColumnType struct {
	Table       string `json:"table"`
	Schema      string `json:"schema"`
	Name        string `json:"name"`
	Type        string `json:"type"`
	DataType    string `json:"datatype"`
	IsArray     bool   `json:"isarray"`
	IsComposite bool   `json:"iscomposite"`
	Builtin     bool   `json:"builtin"` // the type (a domain's base type) is pg_catalog's
}

type ColumnUpdate struct {
	Name    *string `json:"name"`
	Type    *string `json:"type"`
	NotNull *bool   `json:"notnull"`
	Default *string `json:"default"`
	Comment *string `json:"comment"`
}

type CommonBuilder struct{}

type Config struct {
	URL                    string   `comment:"Database URL"`
	MinPoolConnections     int32    `comment:"Miminum connections per pool (default: 10)"`
	MaxPoolConnections     int32    `comment:"Maximum connections per pool (default: 100)"`
	AnonRole               string   `comment:"Anonymous role (default: '' for no anon)"`
	AllowedDatabases       []string `comment:"Allowed databases (default: [] for all)"`
	SchemaSearchPath       []string `comment:"Schema search path (default: [] for Postgres search path)"`
	ExposedSchemas         []string `` /* 143-byte string literal not displayed */
	TransactionMode        string   `` /* 137-byte string literal not displayed */
	AggregatesEnabled      bool     `comment:"Enable aggregate functions (default: true)"`
	MaxRecursiveDepth      int      `comment:"Maximum recursive query depth; 0 disables recursive queries (default: 100)"`
	PoolAcquisitionTimeout int      `comment:"Seconds a request waits for a pool connection before answering 504, 0 to wait without a bound (default: 10)"`
	MaxRows                int64    `` /* 127-byte string literal not displayed */
}

type Constraint struct {
	Name           string   `json:"name"`
	Type           string   `json:"type"` // check, unique, primary, foreign
	Table          string   `json:"table"`
	Schema         string   `json:"schema"`
	Columns        []string `json:"columns"`
	RelatedTable   *string  `json:"reltable"`
	RelatedSchema  *string  `json:"relschema"`
	RelatedColumns []string `json:"relcolumns"`
	Definition     string   `json:"definition"`
}

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

type CustomRows struct {
	FieldDescriptions_ []pgconn.FieldDescription
	RawValues_         [][][]byte
	CurrentRow         int
	TypeMap_           *pgtype.Map
}

type Database struct {
	DatabaseInfo
	// contains filtered or unexported fields
}

type DatabaseInfo struct {
	Name  string `json:"name"`
	Owner string `json:"owner"`
}

type DatabaseUpdate struct {
	Name  *string `json:"name"`
	Owner *string `json:"owner"`
}

type DbConn = pgx.Conn

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

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

type DbPoolConn = pgxpool.Conn

type DirectQueryBuilder struct {
	CommonBuilder
}

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

type Filters = url.Values

type ForeignKey struct {
	Name           string
	Table          string
	Schema         string
	Columns        []string
	RelatedTable   string
	RelatedSchema  string
	RelatedColumns []string
}

type Function struct {
	Name         string     `json:"name"`
	Schema       string     `json:"schema"`
	Arguments    []Argument `json:"arguments"`
	ArgDefaults  int        `json:"argdefaults"` // pronargdefaults: how many of the last input arguments have a default
	Returns      string     `json:"returns"`
	Language     string     `json:"language"`
	Definition   string     `json:"definition"`
	ReturnTypeId uint32     `json:"rettypeid"`
	ReturnIsSet  bool       `json:"retisset"`
	ReturnRows   float32    `json:"retrows"`    // prorows: estimated number of result rows
	HasUnnamed   bool       `json:"hasunnamed"` // has unnamed parameters
	HasOut       bool       `json:"hasout"`     // has OUT, INOUT, TABLE parameters
	IsVariadic   bool       `json:"isvariadic"`
	Volatility   string     `json:"volatility"` // provolatile: i IMMUTABLE, s STABLE, v VOLATILE
}

type JSONSerializer struct {
	TextBuilder
}

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

type ListenerConfig struct {
	Channel        string
	Enabled        bool
	ReconnectDelay time.Duration
}

type NotificationHandler func(ctx context.Context, payload string) error

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

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

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

type Policy struct {
	Name       string   `json:"name"`
	Table      string   `json:"table"`
	Retrictive bool     `json:"deny"`
	Command    string   `json:"command"`
	Roles      []string `json:"roles"`
	Using      *string  `json:"using"`
	Check      *string  `json:"check"`
}

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

type PostgresConfig struct {
	Host     string // host (e.g. localhost) or absolute path to unix domain socket directory (e.g. /private/tmp)
	Port     uint16
	Database string
	User     string
	Password string
}

type Privilege struct {
	TargetName   string   `json:"targetname"`
	TargetSchema string   `json:"targetschema,omitempty"`
	TargetType   string   `json:"targettype"`        // database, schema, table, column, function
	Columns      []string `json:"columns,omitempty"` // to insert column privileges
	Types        []string `json:"types"`
	Grantee      string   `json:"grantee"`
	Grantor      string   `json:"grantor"`
	ACL          string   `json:"acl"`
}

type QueryBuilder interface {
	BuildSelect(table string, parts *QueryParts, options *QueryOptions, info *SchemaInfo) (string, []any, error)
	BuildInsert(table string, records []Record, body []byte, parts *QueryParts, options *QueryOptions, info *SchemaInfo) (string, []any, error)
	BuildUpdate(table string, record Record, parts *QueryParts, options *QueryOptions, info *SchemaInfo) (string, []any, error)
	BuildDelete(table string, parts *QueryParts, options *QueryOptions, info *SchemaInfo) (string, []any, error)
	// BuildExecute calls the function name, whose overload f (nil when unknown)
	// is the one SchemaInfo.FindFunction resolves for the record's keys
	BuildExecute(name string, f *Function, record Record, parts *QueryParts, options *QueryOptions, info *SchemaInfo) (string, []any, error)
	// contains filtered or unexported methods
}

type QueryOptions struct {
	Schema               string
	ContentType          string // json, csv
	ReturnRepresentation bool
	MergeDuplicates      bool
	IgnoreDuplicates     bool
	ParamsAsSingleObject bool
	TxCommit             bool
	TxRollback           bool
	Singular             bool
	HasRange             bool
	RangeMin             int64
	RangeMax             int64
	Count                string // exact, planned, estimated
	JQ                   string // jq program from the jq= query parameter
	JQArgs               string // raw JSON object from the jq_args= query parameter
	// Total is the total of a counted read (Count set), written by the
	// executor: the rows that the request selects, whatever its range
	Total int64
	// contains filtered or unexported fields
}

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

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

type Record = map[string]any

type RecursiveInfo struct {
	StartField       string              // column for base case (e.g. "id")
	StartValue       string              // seed value (e.g. "5")
	RecurseField     string              // FK column to follow (e.g. "manager_id")
	MaxDepth         int                 // max depth; -1 = unlimited (capped by server max)
	ExcludeStart     bool                // true when "after" operator is used instead of "start"
	RecurseUp        bool                // true for recurse!up — follow the FK toward ancestors (single-table only)
	ViaTable         string              // edge table for multi-table recursion (empty = single-table)
	ViaFromCol       string              // edge table column matching the start value (e.g. "src_id")
	ViaToCol         string              // edge table column linking to main table's start field (e.g. "dst_id")
	ViaConditions    *WhereConditionNode // parsed filter tree for the edge table
	ViaBidirectional bool                // true for via!both(...) — follow edges in either direction
	WalkConditions   *WhereConditionNode // filters that prune the walk (walk.* prefix); plain filters are result filters
}

type RelType int

type Relationship struct {
	Type            RelType
	Table           string
	Columns         []string
	RelatedTable    string
	RelatedColumns  []string
	JunctionTable   string
	JColumns        []string
	JRelatedColumns []string
	ForeignKey      string
	// Computed relationship fields
	FunctionName   string // function name (e.g., "read_principals")
	FunctionSchema string // function schema (e.g., "public")
	ReturnIsSet    bool   // whether the function returns SETOF
}

type Request = http.Request

type RequestParser interface {
	// contains filtered or unexported methods
}

type Role struct {
	Name                string   `json:"name"`
	IsSuperUser         bool     `json:"issuperuser"`
	CanLogin            bool     `json:"canlogin"`
	NoInheritPrivileges bool     `json:"noinherit"`
	CanCreateRoles      bool     `json:"cancreateroles"`
	CanCreateDatabases  bool     `json:"cancreatedatabases"`
	CanBypassRLS        bool     `json:"canbypassrls"`
	MemberOf            []string `json:"memberof"` // readonly for now
}

type RoleUpdate struct {
	Name                *string `json:"name"`
	IsSuperUser         *bool   `json:"issuperuser"`
	CanLogin            *bool   `json:"canlogin"`
	NoInheritPrivileges *bool   `json:"noinherit"`
	CanCreateRoles      *bool   `json:"cancreateroles"`
	CanCreateDatabases  *bool   `json:"cancreatedatabases"`
	CanBypassRLS        *bool   `json:"canbypassrls"`
}

type Schema struct {
	Name  string `json:"name"`
	Owner string `json:"owner"`
}

type SchemaError struct {
	Hint string
	// contains filtered or unexported fields
}

type SchemaInfo struct {
	// ServerVersion is the PostgreSQL version as server_version_num (160015 is
	// 16.15), read with the rest of the cache and so refreshed on every schema
	// reload. Gate a feature on it with ServerAtLeast, see its convention.
	ServerVersion int
	// contains filtered or unexported fields
}

type SchemaUpdate struct {
	Name  *string `json:"name"`
	Owner *string `json:"owner"`
}

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

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

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

type SmoothContext struct {
	Db *Database
	// Conn is the request's connection. With deferred variables (see
	// PrepareRequest) the role is not on it yet: take it with GetConn, which
	// applies them, unless the statement goes through the query executor.
	Conn          *DbConn
	Role          string
	RequestParser RequestParser
	QueryBuilder  QueryBuilder
	QueryOptions  QueryOptions
	// contains filtered or unexported fields
}

type Table struct {
	Name        string   `json:"name"`
	Schema      string   `json:"schema"`
	Owner       string   `json:"owner"`
	Comment     *string  `json:"comment"`
	RowSecurity bool     `json:"rowsecurity"`
	Columns     []Column `json:"columns,omitempty"`
	Constraints []string `json:"constraints"`
	Inherits    string   `json:"inherit,omitempty"`
	IfNotExists bool     `json:"ifnotexists,omitempty"`
	HasIndexes  bool     `json:"hasindexes"`
	HasTriggers bool     `json:"hastriggers"`
	IsPartition bool     `json:"ispartition"`
}

type TableUpdate struct {
	Name        *string `json:"name"`
	Schema      *string `json:"schema"`
	Owner       *string `json:"owner"`
	Comment     *string `json:"comment"`
	RowSecurity *bool   `json:"rowsecurity"`
}

type TextBuilder struct {
	strings.Builder
	// contains filtered or unexported fields
}

type TextSerializer interface {
	Serialize(rows pgx.Rows, scalar bool, single bool, info *SchemaInfo) ([]byte, int64, error)
}

type Type struct {
	Id            uint32   `json:"id"`
	Name          string   `json:"name"`
	Schema        string   `json:"schema"`
	IsArray       bool     `json:"isarray"`
	IsRange       bool     `json:"isrange"`
	IsMultirange  bool     `json:"ismultirange"`
	IsComposite   bool     `json:"iscomposite"`
	IsTable       bool     `json:"istable"`
	IsEnum        bool     `json:"isenum"`
	IsDomain      bool     `json:"isdomain"`
	ArraySubType  uint32   `json:"arraysubtype"`
	RangeSubType  *uint32  `json:"rangesubtype"`
	DomainSubType string   `json:"domainsubtype"`
	DomainBaseId  uint32   `json:"domainbaseid"` // typbasetype, the type a domain is over (0 otherwise)
	SubTypeIds    []uint32 `json:"subtypeids"`
	SubTypeNames  []string `json:"subtypenames"`
}

type User struct {
	Name               string   `json:"name"`
	MemberOf           []string `json:"memberof"`
	CanCreateRoles     bool     `json:"cancreateroles"`
	CanCreateDatabases bool     `json:"cancreatedatabases"`
}

type View struct {
	Name         string `json:"name"`
	Schema       string `json:"schema"`
	Owner        string `json:"owner"`
	Definition   string `json:"definition"`
	Materialized bool   `json:"materialized"`
}

type ViewColDep struct {
	ViewSchema string
	ViewName   string
	ViewColumn string
	BaseSchema string
	BaseTable  string
	BaseColumn string
}

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