entviz

package
v0.0.0-...-29569ec Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 19, 2023 License: Apache-2.0 Imports: 21 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func HCL

func HCL(ctx context.Context, hclOpts HCLOptions) ([]byte, error)

HCL generates an Atlas HCL document from an Ent schema. Most of the code below is taken from https://github.com/rotemtam/entprint.

func Share

func Share(ctx context.Context, hclDocument []byte, driver Driver, opts ...ShareOption) (string, error)

Share create and returns an Atlas Cloud Explore link for the given HCL document.

Types

type Driver

type Driver string
const (
	DriverSqlite     Driver = "SQLITE"
	DriverMysql      Driver = "MYSQL"
	DriverPostgresql Driver = "POSTGRESQL"
)

func ParseDevURL

func ParseDevURL(devURL string) (string, Driver, error)

ParseDevURL parses the devURL and returns the Ent dialect as well the Atlas driver name.

type HCLOptions

type HCLOptions struct {
	SchemaPath     string
	Dialect        string
	DevURL         string
	GlobalUniqueID bool
}

HCLOptions are the options that can be provided to HCL.

type ShareOption

type ShareOption func(opts *shareOpts)

func ShareWithEndpoint

func ShareWithEndpoint(endpoint string) ShareOption

ShareWithEndpoint allows providing a custom endpoint to shareHCL.

func ShareWithHttpClient

func ShareWithHttpClient(httpClient *http.Client) ShareOption

ShareWithHttpClient allows proving a custom *http.Client for shareHCL.

type ShareVisualizationMutationResponse

type ShareVisualizationMutationResponse struct {
	ShareVisualization ShareVisualizationMutationShareVisualizationShareVisualizationPayload `json:"shareVisualization"`
}

ShareVisualizationMutationResponse is returned by ShareVisualizationMutation on success.

func ShareVisualizationMutation

func ShareVisualizationMutation(
	ctx context.Context,
	client graphql.Client,
	extID string,
) (*ShareVisualizationMutationResponse, error)

func (*ShareVisualizationMutationResponse) GetShareVisualization

GetShareVisualization returns ShareVisualizationMutationResponse.ShareVisualization, and is useful for accessing the field via an interface.

type ShareVisualizationMutationShareVisualizationShareVisualizationPayload

type ShareVisualizationMutationShareVisualizationShareVisualizationPayload struct {
	Success bool `json:"success"`
}

ShareVisualizationMutationShareVisualizationShareVisualizationPayload includes the requested fields of the GraphQL type ShareVisualizationPayload.

func (*ShareVisualizationMutationShareVisualizationShareVisualizationPayload) GetSuccess

GetSuccess returns ShareVisualizationMutationShareVisualizationShareVisualizationPayload.Success, and is useful for accessing the field via an interface.

type VisualizeMutationResponse

type VisualizeMutationResponse struct {
	Visualize VisualizeMutationVisualizeVisualizationPayload `json:"visualize"`
}

VisualizeMutationResponse is returned by VisualizeMutation on success.

func VisualizeMutation

func VisualizeMutation(
	ctx context.Context,
	client graphql.Client,
	text string,
	driver Driver,
) (*VisualizeMutationResponse, error)

func (*VisualizeMutationResponse) GetVisualize

GetVisualize returns VisualizeMutationResponse.Visualize, and is useful for accessing the field via an interface.

type VisualizeMutationVisualizeVisualizationPayload

type VisualizeMutationVisualizeVisualizationPayload struct {
	Node VisualizeMutationVisualizeVisualizationPayloadNodeVisualization `json:"node"`
}

VisualizeMutationVisualizeVisualizationPayload includes the requested fields of the GraphQL type VisualizationPayload.

func (*VisualizeMutationVisualizeVisualizationPayload) GetNode

GetNode returns VisualizeMutationVisualizeVisualizationPayload.Node, and is useful for accessing the field via an interface.

type VisualizeMutationVisualizeVisualizationPayloadNodeVisualization

type VisualizeMutationVisualizeVisualizationPayloadNodeVisualization struct {
	ExtID string `json:"extID"`
}

VisualizeMutationVisualizeVisualizationPayloadNodeVisualization includes the requested fields of the GraphQL type Visualization.

func (*VisualizeMutationVisualizeVisualizationPayloadNodeVisualization) GetExtID

GetExtID returns VisualizeMutationVisualizeVisualizationPayloadNodeVisualization.ExtID, and is useful for accessing the field via an interface.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL