json

Documentation

Overview

Package json provides functionality for formatting database schemas as JSON.

Index

• type Target
  • func NewTarget() *Target
  • func (t *Target) Capabilities() dberd.TargetCapabilities
  • func (t *Target) FormatSchema(_ context.Context, s dberd.Schema) (dberd.FormattedSchema, error)
  • func (t *Target) RenderSchema(_ context.Context, _ dberd.FormattedSchema) ([]byte, error)

Types

type Target

type Target struct {
}

Target implements the schema formatting and rendering functionality for JSON format.

func NewTarget

func NewTarget() *Target

NewTarget creates and returns a new JSON target instance.

func (*Target) Capabilities

func (t *Target) Capabilities() dberd.TargetCapabilities

Capabilities returns target capabilities.

func (*Target) FormatSchema

func (t *Target) FormatSchema(_ context.Context, s dberd.Schema) (dberd.FormattedSchema, error)

FormatSchema converts a database schema into a JSON-formatted representation. It returns a FormattedSchema containing the JSON data and format type.

func (*Target) RenderSchema

func (t *Target) RenderSchema(_ context.Context, _ dberd.FormattedSchema) ([]byte, error)

RenderSchema is unsupported for json target.