Discover Packages
github.com/flanksource/commons-db
inspect
sql
package
Version:
v0.1.16
Opens a new window with list of versions in this module.
Published: Jul 16, 2026
License: Apache-2.0
Opens a new window with license information.
Imports: 5
Opens a new window with list of imports.
Imported by: 0
Opens a new window with list of known importers.
Documentation
¶
Package sqlinspect provides reusable, read-only SQL catalog inspection.
View Source const (
DefaultMaxRelations = 5000
DefaultMaxColumns = 50000
)
ListDatabases returns databases accessible to the current connection user.
type Catalog struct {
Driver string `json:"driver"`
Database string `json:"database,omitempty"`
Databases []string `json:"databases,omitempty"`
DefaultSchema string `json:"defaultSchema,omitempty"`
Schemas []Schema `json:"schemas"`
Truncated bool `json:"truncated,omitempty"`
TruncateReason string `json:"truncateReason,omitempty"`
}
Inspect returns the current database's schemas, relations and columns using
set-based catalog queries. It deliberately does not inspect other databases
on the same server. Schemas are queried independently so empty schemas remain
visible to callers.
type Column struct {
Name string `json:"name"`
DataType string `json:"dataType,omitempty"`
Ordinal int `json:"ordinal,omitempty"`
}
type Limits struct {
MaxRelations int
MaxColumns int
}
type Relation struct {
Name string `json:"name"`
Type string `json:"type"`
Columns []Column `json:"columns"`
}
type Schema struct {
Name string `json:"name"`
Relations []Relation `json:"relations"`
}
¶
Click to show internal directories.
Click to hide internal directories.
Documentation
¶
Source Files