client

package

v0.40.0 Latest Latest Go to latest Published: May 24, 2026 License: MIT Imports: 14 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

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

Client is used to store the pool of db connection.

func New(opts command.Options) (*Client, error)

New return an instance of the client.

func (c *Client) Catalog(ctx context.Context) (*DBNode, error)

func (c *Client) DB() *sqlx.DB

DB Return the db attribute.

func (c *Client) Driver() string

Driver returns the driver of the database.

func (c *Client) Host() string

func (c *Client) Metadata(table TableRef) (*Metadata, error)

Metadata returns the most relevant data from a given table.

func (c *Client) Query(q string, args ...any) ([][]string, []string, error)

Query returns performs the query and returns the result set and the column names.

type DBNode struct {
	ID         string
	Name       string
	Type       string
	ParentID   string
	ParentName string
	Children   []*DBNode
}

type Metadata struct {
	TableContent Table
	Structure    Table
	Constraints  Table
	Indexes      Table
	TotalPages   int
}

Metadata sums up the most relevant data from a table.

type Table struct {
	Rows    [][]string
	Columns []string
	// contains filtered or unexported fields
}

Table represents a SQL table.

func (t *Table) Name() string

type TableRef struct {
	Schema string
	Name   string
}