database

Documentation

Overview

Package database implements the Database domain.

Index

• func NewClient(conn *rpcc.Conn) *domainClient
• type AddDatabaseClient
• type AddDatabaseReply
• type Database
• type Error
• type ExecuteSQLArgs
  • func NewExecuteSQLArgs(databaseID ID, query string) *ExecuteSQLArgs
• type ExecuteSQLReply
• type GetDatabaseTableNamesArgs
  • func NewGetDatabaseTableNamesArgs(databaseID ID) *GetDatabaseTableNamesArgs
• type GetDatabaseTableNamesReply
• type ID

Functions

func NewClient

func NewClient(conn *rpcc.Conn) *domainClient

NewClient returns a client for the Database domain with the connection set to conn.

Types

type AddDatabaseClient

type AddDatabaseClient interface {
	// Recv calls RecvMsg on rpcc.Stream, blocks until the event is
	// triggered, context canceled or connection closed.
	Recv() (*AddDatabaseReply, error)
	rpcc.Stream
}

AddDatabaseClient is a client for AddDatabase events.

type AddDatabaseReply

type AddDatabaseReply struct {
	Database Database `json:"database"` // No description.
}

AddDatabaseReply is the reply for AddDatabase events.

type Database

type Database struct {
	ID      ID     `json:"id"`      // Database ID.
	Domain  string `json:"domain"`  // Database domain.
	Name    string `json:"name"`    // Database name.
	Version string `json:"version"` // Database version.
}

Database Database object.

Note: This type is experimental.

type Error

type Error struct {
	Message string `json:"message"` // Error message.
	Code    int    `json:"code"`    // Error code.
}

Error Database error.

type ExecuteSQLArgs

type ExecuteSQLArgs struct {
	DatabaseID ID     `json:"databaseId"` // No description.
	Query      string `json:"query"`      // No description.
}

ExecuteSQLArgs represents the arguments for ExecuteSQL in the Database domain.

func NewExecuteSQLArgs

func NewExecuteSQLArgs(databaseID ID, query string) *ExecuteSQLArgs

NewExecuteSQLArgs initializes ExecuteSQLArgs with the required arguments.

type ExecuteSQLReply

type ExecuteSQLReply struct {
	ColumnNames []string          `json:"columnNames,omitempty"` // No description.
	Values      []json.RawMessage `json:"values,omitempty"`      // No description.
	SQLError    *Error            `json:"sqlError,omitempty"`    // No description.
}

ExecuteSQLReply represents the return values for ExecuteSQL in the Database domain.

type GetDatabaseTableNamesArgs

type GetDatabaseTableNamesArgs struct {
	DatabaseID ID `json:"databaseId"` // No description.
}

GetDatabaseTableNamesArgs represents the arguments for GetDatabaseTableNames in the Database domain.

func NewGetDatabaseTableNamesArgs

func NewGetDatabaseTableNamesArgs(databaseID ID) *GetDatabaseTableNamesArgs

NewGetDatabaseTableNamesArgs initializes GetDatabaseTableNamesArgs with the required arguments.

type GetDatabaseTableNamesReply

type GetDatabaseTableNamesReply struct {
	TableNames []string `json:"tableNames"` // No description.
}

GetDatabaseTableNamesReply represents the return values for GetDatabaseTableNames in the Database domain.

type ID

type ID string

ID Unique identifier of Database object.

Note: This type is experimental.