metadata

Documentation

Overview

Package metadata provides access to databases and collections information.

Index

• Constants
• type Collection
  • func (c Collection) Capped() bool
  • func (c *Collection) Scan(src any) error
  • func (c Collection) Value() (driver.Value, error)
• type CollectionCreateParams
  • func (cpp *CollectionCreateParams) Capped() bool
• type IndexInfo
• type IndexKeyPair
• type Indexes
• type Registry
  • func NewRegistry(u string, l *zap.Logger, sp *state.Provider) (*Registry, error)
  • func (r *Registry) Close()
  • func (r *Registry) Collect(ch chan<- prometheus.Metric)
  • func (r *Registry) CollectionCreate(ctx context.Context, params *CollectionCreateParams) (bool, error)
  • func (r *Registry) CollectionDrop(ctx context.Context, dbName, collectionName string) (bool, error)
  • func (r *Registry) CollectionGet(ctx context.Context, dbName, collectionName string) (*Collection, error)
  • func (r *Registry) CollectionList(ctx context.Context, dbName string) ([]*Collection, error)
  • func (r *Registry) CollectionRename(ctx context.Context, dbName, oldCollectionName, newCollectionName string) (bool, error)
  • func (r *Registry) DatabaseDrop(ctx context.Context, dbName string) (bool, error)
  • func (r *Registry) DatabaseGetExisting(ctx context.Context, dbName string) (*fsql.DB, error)
  • func (r *Registry) DatabaseGetOrCreate(ctx context.Context, dbName string) (*fsql.DB, error)
  • func (r *Registry) DatabaseList(ctx context.Context) ([]string, error)
  • func (r *Registry) Describe(ch chan<- *prometheus.Desc)
  • func (r *Registry) IndexesCreate(ctx context.Context, dbName, collectionName string, indexes []IndexInfo) error
  • func (r *Registry) IndexesDrop(ctx context.Context, dbName, collectionName string, indexNames []string) error

Constants

const (
	// DefaultColumn is a column name for all fields.
	DefaultColumn = backends.ReservedPrefix + "sjson"

	// IDColumn is a MySQL path expression for _id field.
	IDColumn = DefaultColumn + "->'$._id'"

	// IDIndexColumn is a column name for MySQL generated column on the field '_id'.
	IDIndexColumn = DefaultColumn + "_id"

	// TableIndexColumn is a column name for MySQL generated column on the field 'table'.
	TableIndexColumn = DefaultColumn + "_table"

	// RecordIDColumn is a name for RecordID column to store capped collection record id.
	RecordIDColumn = backends.ReservedPrefix + "record_id"
)

Types

type Collection

type Collection struct {
	Name            string
	UUID            string
	TableName       string
	Indexes         Indexes
	CappedSize      int64
	CappedDocuments int64
}

Collection represents collection metadata.

Collection value should be immutable to avoid data races. Use [deepCopy] to replace whole value instead of modifying fields of existing value.

func (Collection) Capped

func (c Collection) Capped() bool

Capped returns true if collection is capped.

func (*Collection) Scan

func (c *Collection) Scan(src any) error

Scan implements sql.Scanner interface.

func (Collection) Value

func (c Collection) Value() (driver.Value, error)

Value implements driver.Valuer interface.

type CollectionCreateParams

type CollectionCreateParams struct {
	DBName          string
	Name            string
	CappedSize      int64
	CappedDocuments int64
}

CollectionCreateParams contains parameters for CollectionCreate.

func (*CollectionCreateParams) Capped

func (cpp *CollectionCreateParams) Capped() bool

Capped returns true if capped collection creation is requested.

type IndexInfo

type IndexInfo struct {
	Name   string
	Index  string
	Key    []IndexKeyPair
	Unique bool
}

IndexInfo represents information about a single index.

type IndexKeyPair

type IndexKeyPair struct {
	Field      string
	Descending bool
}

IndexKeyPair consists of a field name and a sort order that are part of the index.

type Indexes

type Indexes []IndexInfo

Indexes represents information about all indexes in a collection.

type Registry

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

Registry provides access to MySQL databases and collections information.

Exported methods and [getPool] are safe for concurrent use. Other unexported methods are not.

All methods should call [getPool] to check authentication. There is no authorization yet - if username/password is correct, all databases and collections are visible as far as Registry is concerned.

Registry metadata is loaded upon first call by client, using conninfo in the context of the client.

func NewRegistry

func NewRegistry(u string, l *zap.Logger, sp *state.Provider) (*Registry, error)

NewRegistry creates a registry for the MySQL databases with a given base URI.

func (*Registry) Close

func (r *Registry) Close()

Close closes the registry.

func (*Registry) Collect

func (r *Registry) Collect(ch chan<- prometheus.Metric)

Collect implements prometheus.Collector.

func (*Registry) CollectionCreate

func (r *Registry) CollectionCreate(ctx context.Context, params *CollectionCreateParams) (bool, error)

CollectionCreate creates a collection in the database. Database will be created automatically if needed.

Returned boolean value indicates whether the collection was created. If collection already exists, (false, nil) is returned.

If the user is not authenticated, it returns error.

func (*Registry) CollectionDrop

func (r *Registry) CollectionDrop(ctx context.Context, dbName, collectionName string) (bool, error)

CollectionDrop drops a collection in the database.

Returned boolean value indicates whether the collection was dropped. If database or collection did not exist, (false, nil) is returned.

If the user is not authenticated, it returns error.

func (*Registry) CollectionGet

func (r *Registry) CollectionGet(ctx context.Context, dbName, collectionName string) (*Collection, error)

CollectionGet returns a copy of collection metadata. It can be safely modified by a caller.

If database or collection does not exist, nil is returned.

If the user is not authenticated, it returns error.

func (*Registry) CollectionList

func (r *Registry) CollectionList(ctx context.Context, dbName string) ([]*Collection, error)

CollectionList returns a sorted copy of collections in the database.

If database does not exist, no error is returned.

If the user is not authenticated, it returns error.

func (*Registry) CollectionRename

func (r *Registry) CollectionRename(ctx context.Context, dbName, oldCollectionName, newCollectionName string) (bool, error)

CollectionRename renames a collection in the database.

The collection name is updated, but the original table name is kept.

Returned boolean value indicates whether the collection was renamed. If database or collection did not exist, (false, nil) is returned.

If the user is not authenticated, it returns error.

func (*Registry) DatabaseDrop

func (r *Registry) DatabaseDrop(ctx context.Context, dbName string) (bool, error)

DatabaseDrop drops the database.

Returned boolean value indicates whether the database was dropped. If database does not exist, (false, nil) is returned.

If user is not authenticated, it returns error.

func (*Registry) DatabaseGetExisting

func (r *Registry) DatabaseGetExisting(ctx context.Context, dbName string) (*fsql.DB, error)

DatabaseGetExisting returns a connection to existing database or nil if it doesn't exist.

If the user is not authenticated, it returns error.

func (*Registry) DatabaseGetOrCreate

func (r *Registry) DatabaseGetOrCreate(ctx context.Context, dbName string) (*fsql.DB, error)

DatabaseGetOrCreate returns a connection to existing database or newly created database.

The dbName must be a validated database name.

If the user is not authenticated, it returns error.

func (*Registry) DatabaseList

func (r *Registry) DatabaseList(ctx context.Context) ([]string, error)

DatabaseList returns a sorted list of existing databases.

If the user is not authenticated, it returns an error.

func (*Registry) Describe

func (r *Registry) Describe(ch chan<- *prometheus.Desc)

Describe implements prometheus.Collector.

func (*Registry) IndexesCreate

func (r *Registry) IndexesCreate(ctx context.Context, dbName, collectionName string, indexes []IndexInfo) error

IndexesCreate creates indexes in the collection.

Existing indexes with given names are ignored.

If the user is not authenticated, it returns error.

func (*Registry) IndexesDrop

func (r *Registry) IndexesDrop(ctx context.Context, dbName, collectionName string, indexNames []string) error

IndexesDrop removes given connection's indexes.

Non-existing indexes are ignored.

If database or collection does not exist, nil is returned.

If the user is not authenticated, it returns error.