rdsdata – github.com/aws/aws-sdk-go-v2/service/rdsdata Index | Files | Directories

package rdsdata

import "github.com/aws/aws-sdk-go-v2/service/rdsdata"

Index

Constants

const ServiceAPIVersion = "2018-08-01"
const ServiceID = "RDS Data"

Functions

func AddResolveEndpointMiddleware

func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func RemoveResolveEndpointMiddleware

func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error

Types

type BatchExecuteStatementInput

type BatchExecuteStatementInput struct {
	// The name of the database.
	Database *string
	// The parameter set for the batch operation. The SQL statement is executed as many
	// times as the number of parameter sets provided. To execute a SQL statement with
	// no parameters, use one of the following options:
	//
	//     * Specify one or more
	// empty parameter sets.
	//
	//     * Use the ExecuteStatement operation instead of the
	// BatchExecuteStatement operation.
	//
	// Array parameters are not supported.
	ParameterSets [][]*types.SqlParameter
	// The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
	ResourceArn *string
	// The name of the database schema.
	Schema *string
	// The name or ARN of the secret that enables access to the DB cluster.
	SecretArn *string
	// The SQL statement to run.
	Sql *string
	// The identifier of a transaction that was started by using the BeginTransaction
	// operation. Specify the transaction ID of the transaction that you want to
	// include the SQL statement in. If the SQL statement is not part of a transaction,
	// don't set this parameter.
	TransactionId *string
}

The request parameters represent the input of a SQL statement over an array of data.

type BatchExecuteStatementOutput

type BatchExecuteStatementOutput struct {
	// The execution results of each batch entry.
	UpdateResults []*types.UpdateResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response elements represent the output of a SQL statement over an array of data.

type BeginTransactionInput

type BeginTransactionInput struct {
	// The name of the database.
	Database *string
	// The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
	ResourceArn *string
	// The name of the database schema.
	Schema *string
	// The name or ARN of the secret that enables access to the DB cluster.
	SecretArn *string
}

The request parameters represent the input of a request to start a SQL transaction.

type BeginTransactionOutput

type BeginTransactionOutput struct {
	// The transaction ID of the transaction started by the call.
	TransactionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response elements represent the output of a request to start a SQL transaction.

type Client

type Client struct {
	// contains filtered or unexported fields
}

Amazon RDS Data Service Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless DB cluster. To run these statements, you work with the Data Service API. For more information about the Data Service API, see Using the Data API for Aurora Serverless (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the Amazon Aurora User Guide. If you have questions or comments related to the Data API, send email to Rds-data-api-feedback@amazon.com (mailto:Rds-data-api-feedback@amazon.com).

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) BatchExecuteStatement

func (c *Client) BatchExecuteStatement(ctx context.Context, params *BatchExecuteStatementInput, optFns ...func(*Options)) (*BatchExecuteStatementOutput, error)

Runs a batch SQL statement over an array of data. You can run bulk update and insert operations for multiple records using a DML statement with different parameter sets. Bulk operations can provide a significant performance improvement over individual insert and update operations. If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically.

func (*Client) BeginTransaction

func (c *Client) BeginTransaction(ctx context.Context, params *BeginTransactionInput, optFns ...func(*Options)) (*BeginTransactionOutput, error)

Starts a SQL transaction. <important> <p>A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours.</p> <p>A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's committed, it's rolled back automatically.</p> <p>DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate <code>ExecuteStatement</code> call with <code>continueAfterTimeout</code> enabled.</p> </important>

func (*Client) CommitTransaction

func (c *Client) CommitTransaction(ctx context.Context, params *CommitTransactionInput, optFns ...func(*Options)) (*CommitTransactionOutput, error)

Ends a SQL transaction started with the BeginTransaction operation and commits the changes.

func (*Client) ExecuteSql

func (c *Client) ExecuteSql(ctx context.Context, params *ExecuteSqlInput, optFns ...func(*Options)) (*ExecuteSqlOutput, error)

Runs one or more SQL statements. This operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement operation.

func (*Client) ExecuteStatement

func (c *Client) ExecuteStatement(ctx context.Context, params *ExecuteStatementInput, optFns ...func(*Options)) (*ExecuteStatementOutput, error)

Runs a SQL statement against a database. If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically. The response size limit is 1 MB. If the call returns more than 1 MB of response data, the call is terminated.

func (*Client) RollbackTransaction

func (c *Client) RollbackTransaction(ctx context.Context, params *RollbackTransactionInput, optFns ...func(*Options)) (*RollbackTransactionOutput, error)

Performs a rollback of a transaction. Rolling back a transaction cancels its changes.

type CommitTransactionInput

type CommitTransactionInput struct {
	// The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
	ResourceArn *string
	// The name or ARN of the secret that enables access to the DB cluster.
	SecretArn *string
	// The identifier of the transaction to end and commit.
	TransactionId *string
}

The request parameters represent the input of a commit transaction request.

type CommitTransactionOutput

type CommitTransactionOutput struct {
	// The status of the commit operation.
	TransactionStatus *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response elements represent the output of a commit transaction request.

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)

type ExecuteSqlInput

type ExecuteSqlInput struct {
	// The Amazon Resource Name (ARN) of the secret that enables access to the DB
	// cluster.
	AwsSecretStoreArn *string
	// The name of the database.
	Database *string
	// The ARN of the Aurora Serverless DB cluster.
	DbClusterOrInstanceArn *string
	// The name of the database schema.
	Schema *string
	// One or more SQL statements to run on the DB cluster. You can separate SQL
	// statements from each other with a semicolon (;). Any valid SQL statement is
	// permitted, including data definition, data manipulation, and commit statements.
	SqlStatements *string
}

The request parameters represent the input of a request to run one or more SQL statements.

type ExecuteSqlOutput

type ExecuteSqlOutput struct {
	// The results of the SQL statement or statements.
	SqlStatementResults []*types.SqlStatementResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response elements represent the output of a request to run one or more SQL statements.

type ExecuteStatementInput

type ExecuteStatementInput struct {
	// A value that indicates whether to continue running the statement after the call
	// times out. By default, the statement stops running when the call times out. For
	// DDL statements, we recommend continuing to run the statement after the call
	// times out. When a DDL statement terminates before it is finished running, it can
	// result in errors and possibly corrupted data structures.
	ContinueAfterTimeout *bool
	// The name of the database.
	Database *string
	// A value that indicates whether to include metadata in the results.
	IncludeResultMetadata *bool
	// The parameters for the SQL statement. Array parameters are not supported.
	Parameters []*types.SqlParameter
	// The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
	ResourceArn *string
	// Options that control how the result set is returned.
	ResultSetOptions *types.ResultSetOptions
	// The name of the database schema. Currently, the schema parameter isn't
	// supported.
	Schema *string
	// The name or ARN of the secret that enables access to the DB cluster.
	SecretArn *string
	// The SQL statement to run.
	Sql *string
	// The identifier of a transaction that was started by using the BeginTransaction
	// operation. Specify the transaction ID of the transaction that you want to
	// include the SQL statement in. If the SQL statement is not part of a transaction,
	// don't set this parameter.
	TransactionId *string
}

The request parameters represent the input of a request to run a SQL statement against a database.

type ExecuteStatementOutput

type ExecuteStatementOutput struct {
	// Metadata for the columns included in the results.
	ColumnMetadata []*types.ColumnMetadata
	// Values for fields generated during the request.  <note> <p>The
	// <code>generatedFields</code> data isn't supported by Aurora PostgreSQL. To get
	// the values of generated fields, use the <code>RETURNING</code> clause. For more
	// information, see <a
	// href="https://www.postgresql.org/docs/10/dml-returning.html">Returning Data From
	// Modified Rows</a> in the PostgreSQL documentation.</p> </note>
	GeneratedFields []types.Field
	// The number of records updated by the request.
	NumberOfRecordsUpdated *int64
	// The records returned by the SQL statement.
	Records [][]types.Field

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response elements represent the output of a request to run a SQL statement against a database.

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error
}

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions ResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetCredentials

func (o Options) GetCredentials() aws.CredentialsProvider

func (Options) GetEndpointOptions

func (o Options) GetEndpointOptions() ResolverOptions

func (Options) GetEndpointResolver

func (o Options) GetEndpointResolver() EndpointResolver

func (Options) GetHTTPSignerV4

func (o Options) GetHTTPSignerV4() HTTPSignerV4

func (Options) GetRegion

func (o Options) GetRegion() string

func (Options) GetRetryer

func (o Options) GetRetryer() retry.Retryer

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type ResolveEndpointMiddlewareOptions

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions

type ResolverOptions = internalendpoints.Options

ResolverOptions is the service endpoint resolver options

type RollbackTransactionInput

type RollbackTransactionInput struct {
	// The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
	ResourceArn *string
	// The name or ARN of the secret that enables access to the DB cluster.
	SecretArn *string
	// The identifier of the transaction to roll back.
	TransactionId *string
}

The request parameters represent the input of a request to perform a rollback of a transaction.

type RollbackTransactionOutput

type RollbackTransactionOutput struct {
	// The status of the rollback operation.
	TransactionStatus *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response elements represent the output of a request to perform a rollback of a transaction.

Source Files

api_client.go api_op_BatchExecuteStatement.go api_op_BeginTransaction.go api_op_CommitTransaction.go api_op_ExecuteSql.go api_op_ExecuteStatement.go api_op_RollbackTransaction.go deserializers.go endpoints.go serializers.go validators.go

Directories

PathSynopsis
internal
types
Version
v0.1.0
Published
Sep 29, 2020
Platform
js/wasm
Imports
26 packages
Last checked
now

Tools for package owners.