tablefq

Documentation

Overview

Package tablefq is a tiny package that holds the tablefq.T type, which is a fully-qualified SQL table name. This package is an experiment, and may be changed or removed.

Index

• type Any
• type T
  • func From[X Any](t X) T
  • func New(tbl string) T
  • func (t T) Render(quoteFn func(s string) string) string
  • func (t T) String() string

Types

type Any

type Any interface {
	string | T
}

Any is a type constraint for a table name, which can be a string (just the table name without catalog or schema) or a fully-qualified T.

REVISIT: Probably get rid of tablefq.Any, if it's only used in one place.

type T

type T struct {
	// Catalog is the database, e.g. "sakila".
	Catalog string

	// Schema is the namespace, e.g. "public".
	Schema string

	// Table is the table name, e.g. "actor".
	Table string
}

T is a fully-qualified table name, of the form CATALOG.SCHEMA.NAME, e.g. "sakila"."public"."actor".

func From

func From[X Any](t X) T

From returns a T from an Any, which can be either a string (just the table name) or a fully-qualified table, including catalog, schema, and table name.

func New

func New(tbl string) T

New returns a new tablefq.T with the given T.Table value, and empty T.Catalog and T.Schema values.

func (T) Render

func (t T) Render(quoteFn func(s string) string) string

Render renders t using quoteFn, e.g. stringz.DoubleQuote.

func (T) String

func (t T) String() string

String returns a default representation of t using stringz.DoubleQuote for the components. Use T.Render to control the output format.