types

package
v1.25.4 Latest Latest
Warning

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

Go to latest
Published: Mar 29, 2024 License: Apache-2.0 Imports: 4 Imported by: 5

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActiveStatementsExceededException added in v1.2.0

type ActiveStatementsExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The number of active statements exceeds the limit.

func (*ActiveStatementsExceededException) Error added in v1.2.0

func (*ActiveStatementsExceededException) ErrorCode added in v1.2.0

func (*ActiveStatementsExceededException) ErrorFault added in v1.2.0

func (*ActiveStatementsExceededException) ErrorMessage added in v1.2.0

func (e *ActiveStatementsExceededException) ErrorMessage() string

type BatchExecuteStatementException added in v1.5.0

type BatchExecuteStatementException struct {
	Message *string

	ErrorCodeOverride *string

	StatementId *string
	// contains filtered or unexported fields
}

An SQL statement encountered an environmental error while running.

func (*BatchExecuteStatementException) Error added in v1.5.0

func (*BatchExecuteStatementException) ErrorCode added in v1.5.0

func (e *BatchExecuteStatementException) ErrorCode() string

func (*BatchExecuteStatementException) ErrorFault added in v1.5.0

func (*BatchExecuteStatementException) ErrorMessage added in v1.5.0

func (e *BatchExecuteStatementException) ErrorMessage() string

type ColumnMetadata

type ColumnMetadata struct {

	// The default value of the column.
	ColumnDefault *string

	// A value that indicates whether the column is case-sensitive.
	IsCaseSensitive bool

	// A value that indicates whether the column contains currency values.
	IsCurrency bool

	// A value that indicates whether an integer column is signed.
	IsSigned bool

	// The label for the column.
	Label *string

	// The length of the column.
	Length int32

	// The name of the column.
	Name *string

	// A value that indicates whether the column is nullable.
	Nullable int32

	// The precision value of a decimal number column.
	Precision int32

	// The scale value of a decimal number column.
	Scale int32

	// The name of the schema that contains the table that includes the column.
	SchemaName *string

	// The name of the table that includes the column.
	TableName *string

	// The database-specific data type of the column.
	TypeName *string
	// contains filtered or unexported fields
}

The properties (metadata) of a column.

type DatabaseConnectionException added in v1.10.0

type DatabaseConnectionException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Connection to a database failed.

func (*DatabaseConnectionException) Error added in v1.10.0

func (*DatabaseConnectionException) ErrorCode added in v1.10.0

func (e *DatabaseConnectionException) ErrorCode() string

func (*DatabaseConnectionException) ErrorFault added in v1.10.0

func (*DatabaseConnectionException) ErrorMessage added in v1.10.0

func (e *DatabaseConnectionException) ErrorMessage() string

type ExecuteStatementException

type ExecuteStatementException struct {
	Message *string

	ErrorCodeOverride *string

	StatementId *string
	// contains filtered or unexported fields
}

The SQL statement encountered an environmental error while running.

func (*ExecuteStatementException) Error

func (e *ExecuteStatementException) Error() string

func (*ExecuteStatementException) ErrorCode

func (e *ExecuteStatementException) ErrorCode() string

func (*ExecuteStatementException) ErrorFault

func (*ExecuteStatementException) ErrorMessage

func (e *ExecuteStatementException) ErrorMessage() string

type Field

type Field interface {
	// contains filtered or unexported methods
}

A data value in a column.

The following types satisfy this interface:

FieldMemberBlobValue
FieldMemberBooleanValue
FieldMemberDoubleValue
FieldMemberIsNull
FieldMemberLongValue
FieldMemberStringValue
Example (OutputUsage)
// Code generated by smithy-go-codegen DO NOT EDIT.

package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/redshiftdata/types"
)

func main() {
	var union types.Field
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.FieldMemberBlobValue:
		_ = v.Value // Value is []byte

	case *types.FieldMemberBooleanValue:
		_ = v.Value // Value is bool

	case *types.FieldMemberDoubleValue:
		_ = v.Value // Value is float64

	case *types.FieldMemberIsNull:
		_ = v.Value // Value is bool

	case *types.FieldMemberLongValue:
		_ = v.Value // Value is int64

	case *types.FieldMemberStringValue:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

var _ *string
var _ *bool
var _ *int64
var _ *float64
var _ []byte
Output:

type FieldMemberBlobValue

type FieldMemberBlobValue struct {
	Value []byte
	// contains filtered or unexported fields
}

A value of the BLOB data type.

type FieldMemberBooleanValue

type FieldMemberBooleanValue struct {
	Value bool
	// contains filtered or unexported fields
}

A value of the Boolean data type.

type FieldMemberDoubleValue

type FieldMemberDoubleValue struct {
	Value float64
	// contains filtered or unexported fields
}

A value of the double data type.

type FieldMemberIsNull

type FieldMemberIsNull struct {
	Value bool
	// contains filtered or unexported fields
}

A value that indicates whether the data is NULL.

type FieldMemberLongValue

type FieldMemberLongValue struct {
	Value int64
	// contains filtered or unexported fields
}

A value of the long data type.

type FieldMemberStringValue

type FieldMemberStringValue struct {
	Value string
	// contains filtered or unexported fields
}

A value of the string data type.

type InternalServerException

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The Amazon Redshift Data API operation failed due to invalid input.

func (*InternalServerException) Error

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage

func (e *InternalServerException) ErrorMessage() string

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId *string
	// contains filtered or unexported fields
}

The Amazon Redshift Data API operation failed due to a missing resource.

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

type SqlParameter added in v1.4.0

type SqlParameter struct {

	// The name of the parameter.
	//
	// This member is required.
	Name *string

	// The value of the parameter. Amazon Redshift implicitly converts to the proper
	// data type. For more information, see Data types (https://docs.aws.amazon.com/redshift/latest/dg/c_Supported_data_types.html)
	// in the Amazon Redshift Database Developer Guide.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

A parameter used in a SQL statement.

type StatementData

type StatementData struct {

	// The SQL statement identifier. This value is a universally unique identifier
	// (UUID) generated by Amazon Redshift Data API.
	//
	// This member is required.
	Id *string

	// The date and time (UTC) the statement was created.
	CreatedAt *time.Time

	// A value that indicates whether the statement is a batch query request.
	IsBatchStatement *bool

	// The parameters used in a SQL statement.
	QueryParameters []SqlParameter

	// The SQL statement.
	QueryString *string

	// One or more SQL statements. Each query string in the array corresponds to one
	// of the queries in a batch query request.
	QueryStrings []string

	// The name or Amazon Resource Name (ARN) of the secret that enables access to the
	// database.
	SecretArn *string

	// The name of the SQL statement.
	StatementName *string

	// The status of the SQL statement. An example is the that the SQL statement
	// finished.
	Status StatusString

	// The date and time (UTC) that the statement metadata was last updated.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

The SQL statement to run.

type StatementStatusString added in v1.5.0

type StatementStatusString string
const (
	StatementStatusStringSubmitted StatementStatusString = "SUBMITTED"
	StatementStatusStringPicked    StatementStatusString = "PICKED"
	StatementStatusStringStarted   StatementStatusString = "STARTED"
	StatementStatusStringFinished  StatementStatusString = "FINISHED"
	StatementStatusStringAborted   StatementStatusString = "ABORTED"
	StatementStatusStringFailed    StatementStatusString = "FAILED"
)

Enum values for StatementStatusString

func (StatementStatusString) Values added in v1.5.0

Values returns all known values for StatementStatusString. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type StatusString

type StatusString string
const (
	StatusStringSubmitted StatusString = "SUBMITTED"
	StatusStringPicked    StatusString = "PICKED"
	StatusStringStarted   StatusString = "STARTED"
	StatusStringFinished  StatusString = "FINISHED"
	StatusStringAborted   StatusString = "ABORTED"
	StatusStringFailed    StatusString = "FAILED"
	StatusStringAll       StatusString = "ALL"
)

Enum values for StatusString

func (StatusString) Values

func (StatusString) Values() []StatusString

Values returns all known values for StatusString. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SubStatementData added in v1.5.0

type SubStatementData struct {

	// The identifier of the SQL statement. This value is a universally unique
	// identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the
	// number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2
	// has a suffix of :2 that indicates the second SQL statement of a batch query.
	//
	// This member is required.
	Id *string

	// The date and time (UTC) the statement was created.
	CreatedAt *time.Time

	// The amount of time in nanoseconds that the statement ran.
	Duration int64

	// The error message from the cluster if the SQL statement encountered an error
	// while running.
	Error *string

	// A value that indicates whether the statement has a result set. The result set
	// can be empty. The value is true for an empty result set.
	HasResultSet *bool

	// The SQL statement text.
	QueryString *string

	// The SQL statement identifier. This value is a universally unique identifier
	// (UUID) generated by Amazon Redshift Data API.
	RedshiftQueryId int64

	// Either the number of rows returned from the SQL statement or the number of rows
	// affected. If result size is greater than zero, the result rows can be the number
	// of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and
	// others. A -1 indicates the value is null.
	ResultRows int64

	// The size in bytes of the returned results. A -1 indicates the value is null.
	ResultSize int64

	// The status of the SQL statement. An example is the that the SQL statement
	// finished.
	Status StatementStatusString

	// The date and time (UTC) that the statement metadata was last updated.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

Information about an SQL statement.

type TableMember

type TableMember struct {

	// The name of the table.
	Name *string

	// The schema containing the table.
	Schema *string

	// The type of the table. Possible values include TABLE, VIEW, SYSTEM TABLE,
	// GLOBAL TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM.
	Type *string
	// contains filtered or unexported fields
}

The properties of a table.

type UnknownUnionMember

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type ValidationException

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The Amazon Redshift Data API operation failed due to invalid input.

func (*ValidationException) Error

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage

func (e *ValidationException) ErrorMessage() string

Jump to

Keyboard shortcuts

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