sqlx

Documentation

Overview

Package sqlx contains "internal" SQL transform interfaces that are needed by the SQL expansion providers.

The purposes of introducing a separate package from sql are: - to separate these "internal" APIs from the user-facing ones; - to break potential circular dependencies: sql -> default expansion service/handler -> sql.

Index

• Constants
• type ExpansionPayload
• type Option
• type Options

Constants

const (
	// Urn is the URN for SQL transforms.
	Urn = "beam:external:java:sql:v1"

	// DefaultExpansionAddr is the default expansion service address for SQL.
	// TODO: Change this to the Beam Java expansion address once Beam SQL
	// is implemented in Beam Go.
	DefaultExpansionAddr = "undefined"
)

Types

type ExpansionPayload

type ExpansionPayload struct {
	Query   string `beam:"query"`
	Dialect string `beam:"dialect"`
	// contains filtered or unexported fields
}

ExpansionPayload is the struct of the payload encoded in ExpansionRequest.

type Option

type Option struct {
	Urn     string `beam:"urn"`
	Payload []byte `beam:"payload"`
}

Option represents a custom SQL transform option. The option provider is responsible for marshaling and unmarshaling the option.

type Options

type Options interface {
	// Add adds a custom option.
	Add(opt Option)
}

Options is the interface for adding SQL transform options.