nosqldb

type AuthorizationProvider interface {
	// AuthorizationScheme returns a string that represents the supported
	// authorization scheme for this provider.
	//
	// The available authorization schemes are:
	//
	//   Bearer    : supported for the on-premise Oracle NoSQL server and the Oracle NoSQL cloud simulator
	//   Signature : supported for the Oracle NoSQL cloud service that uses OCI IAM for request authorization
	//
	AuthorizationScheme() string

	// AuthorizationString returns an authorization string for the specified request.
	// The returned string will be sent to the server in the request for authorization.
	// Authorization information can be request-dependent.
	AuthorizationString(req auth.Request) (string, error)

	// Some authorization providers need the entire http request to sign it
	// note this method may add or change header fields (but should never modify the
	// http data payload)
	SignHTTPRequest(httpReq *http.Request) error

	// Close releases resources allocated by the provider.
	Close() error
}

type Capacity struct {
	// ReadKB represents the number of kilo bytes consumed for reads.
	ReadKB int `json:"readKB"`

	// WriteKB represents the number of kilo bytes consumed for writes.
	WriteKB int `json:"writeKB"`

	// ReadUnits represents the number of read units consumed for reads.
	//
	// A read unit represents 1 eventually consistent read per second for data
	// up to 1 KB in size. A read that is absolutely consistent is double that,
	// consuming 2 read units for a read of up to 1 KB in size.
	ReadUnits int `json:"readUnits"`
}

type Client struct {
	// Config specifies the configuration parameters associated with the Client.
	// Most configuration parameters have default values that should suffice for use.
	Config

	// HTTPClient represents an HTTP client associated with a Client instance.
	// It is used to send Client requests to server and receive responses.
	HTTPClient *httputil.HTTPClient
	// contains filtered or unexported fields
}

type Config struct {
	// Endpoint specifies the Oracle NoSQL server endpoint that clients connect to.
	// It is required when connect to the Oracle NoSQL cloud simulator or
	// the on-premise Oracle NoSQL server.
	// It must include the target address, and may include protocol and port.
	// The syntax is:
	//
	//   [http[s]://]host[:port]
	//
	// For example, these are valid endpoints:
	//
	//   localhost:8080
	//   http://localhost:8080
	//   https://localhost:8090
	//
	// If port is omitted, the endpoint defaults to 443.
	// If protocol is omitted, the endpoint uses https if the port is 443, and
	// http in all other cases.
	Endpoint string `json:"endpoint"`

	// Region specifies the region for the Oracle NoSQL cloud service that clients connect to.
	// Region takes precedence over the "region" property that may be specified
	// in the OCI configuration file which is ~/.oci/config by default.
	//
	// This is used for cloud service only.
	Region common.Region `json:"region"`

	// Mode specifies the configuration mode for client, which is one of:
	//
	//   "cloud": for connecting to a NoSQL cloud service
	//   "cloudsim": for connecting to a local cloud simulator
	//   "onprem": for connecting to an on-premise NoSQL server
	//
	// If not set, the "cloud" mode is used by default.
	Mode string `json:"mode"`

	// Username specifies the user that used to authenticate with the server.
	// This is only used for on-premise NoSQL server that configured with security.
	Username string `json:"username,omitempty"`

	// Password specifies the password for user that used to authenticate with the server.
	// This is only used for on-premise NoSQL server that configured with security.
	Password []byte `json:"password,omitempty"`

	// Default Configurations for requests.
	RequestConfig `json:"requestConfig,omitempty"`

	// Configurations for HTTP client.
	httputil.HTTPConfig `json:"httpConfig,omitempty"`

	// Configurations for logging.
	LoggingConfig `json:"loggingConfig,omitempty"`

	// Authorization provider.
	// If not specified, use the default authorization provider depending on the
	// configuration mode:
	//
	//   use iam.SignatureProvider for NoSQL cloud service that uses OCI IAM.
	//   use kvstore.AccessTokenProvider for the secure NoSQL servers on-premise.
	//
	AuthorizationProvider

	// RetryHandler specifies a handler used to handle operation retries.
	RetryHandler

	// By default, internal rate limiting is disabled. Set RateLimitingEnabled to
	// true before creating a client to enable internal rate limiting.
	RateLimitingEnabled bool `json:"rateLimitingEnabled,omitempty"`

	// RateLimiterPercentage is a default percentage of table limits to use with
	// rate limiting. This may be useful for cases where a client should only use
	// a portion of full table limits. This only applies if internal rate limiting is
	// enabled.
	// The default for this value is 100.0 (full table limits).
	RateLimiterPercentage float64
	// contains filtered or unexported fields
}

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

type DelayInfo struct {
	// RateLimitTime represents the time delayed due to internal rate limiting.
	RateLimitTime time.Duration
	// RetryTime represents the time delayed due to internal request retries.
	RetryTime time.Duration
}

type DeleteRequest struct {
	// TableName specifies the name of table from which to delete the row.
	// It is required and must be non-empty.
	TableName string `json:"tableName"`

	// Key specifies the primary key used for the delete operation.
	// It is required and must be non-nil.
	Key *types.MapValue `json:"key"`

	// ReturnRow specifies whether information about the existing row should be
	// returned on failure because of a version mismatch.
	// If a match version has not been specified via MatchVersion, this
	// parameter is ignored and there will be no return information.
	//
	// It is optional and defaults to false.
	//
	// Using this option may incur additional cost.
	ReturnRow bool `json:"returnRow"`

	// MatchVersion specifies the version to use for a conditional delete
	// operation. The version is usually obtained from GetResult.Version or
	// other method that returns a version.
	//
	// It is optional.
	// If set, the delete operation will succeed only if the row exists and its
	// version matches the one specified.
	//
	// Using this option will incur additional cost.
	MatchVersion types.Version `json:"matchVersion,omitempty"`

	// Timeout specifies the timeout value for the request.
	// It is optional.
	// If set, it must be greater than or equal to 1 millisecond, otherwise an
	// IllegalArgument error will be returned.
	// If not set, the default timeout value configured for Client is used,
	// which is determined by RequestConfig.DefaultRequestTimeout().
	Timeout time.Duration `json:"timeout"`

	// Durability is currently only used in On-Prem installations.
	// Added in SDK Version 1.3.0
	Durability types.Durability `json:"durability"`

	// Namespace is used on-premises only. It defines a namespace to use
	// for the request. It is optional.
	// If a namespace is specified in the table name for the request
	// (using the namespace:tablename format), that value will override this
	// setting.
	// If not set, the default namespace value configured for Client is used,
	// which is determined by RequestConfig.DefaultNamespace().
	// This is only available with on-premises installations using NoSQL
	// Server versions 23.3 and above.
	Namespace string `json:"namespace,omitempty"`

	common.InternalRequestData
	// contains filtered or unexported fields
}

type DeleteResult struct {
	Capacity
	DelayInfo

	// WriteResult is used to get the information about the existing row such as
	// ExistingValue and ExistingVersion on operation failure.
	WriteResult

	// Success represents if the delete operation succeeded or not.
	Success bool `json:"success"`
}

type FPArithSpec struct {
	// Precision specifies the desired decimal precision (in number of digits)
	// for arithematic operation result of floating-point value.
	Precision uint

	// RoundingMode determines how an arithematic operation result of
	// floating-point value is rounded to the desired precision.
	RoundingMode big.RoundingMode
}

type GetIndexesRequest struct {
	// TableName specifies the name of table to which the indexes belong.
	// It is required and must be non-empty.
	TableName string `json:"tableName"`

	// IndexName specifies the name of index.
	//
	// It is optional.
	// If set, the request is intended for retrieving information of the
	// specific index.
	// If not set, the request is intended for retrieving information of
	// all indexes on the table.
	IndexName string `json:"indexName,omitempty"`

	// Timeout specifies the timeout value for the request.
	// It is optional.
	// If set, it must be greater than or equal to 1 millisecond, otherwise an
	// IllegalArgument error will be returned.
	// If not set, the default timeout value configured for Client is used,
	// which is determined by RequestConfig.DefaultRequestTimeout().
	Timeout time.Duration `json:"timeout"`

	// Namespace is used on-premises only. It defines a namespace to use
	// for the request. It is optional.
	// If a namespace is specified in the table name for the request
	// (using the namespace:tablename format), that value will override this
	// setting.
	// If not set, the default namespace value configured for Client is used,
	// which is determined by RequestConfig.DefaultNamespace().
	// This is only available with on-premises installations using NoSQL
	// Server versions 23.3 and above.
	Namespace string `json:"namespace,omitempty"`

	common.InternalRequestData
}

type GetIndexesResult struct {
	DelayInfo

	// Indexes represents a slice of IndexInfo that contains index information
	// returned by the operation.
	Indexes []IndexInfo `json:"indexes"`
	// contains filtered or unexported fields
}

type GetRequest struct {

	// TableName specifies the name of table from which to get the row.
	// It is required and must be non-empty.
	TableName string `json:"tableName"`

	// Key specifies the primary key used for the get operation.
	// It is required and must be non-nil.
	Key *types.MapValue `json:"key"`

	// Timeout specifies the timeout value for the request.
	// It is optional.
	// If set, it must be greater than or equal to 1 millisecond, otherwise an
	// IllegalArgument error will be returned.
	// If not set, the default timeout value configured for Client is used,
	// which is determined by RequestConfig.DefaultRequestTimeout().
	Timeout time.Duration `json:"timeout"`

	// Consistency specifies desired consistency policy for the request.
	// It is optional.
	// If set, it must be either types.Absolute or types.Eventual, otherwise
	// an IllegalArgument error will be returned.
	// If not set, the default consistency value configured for Client is used,
	// which is determined by RequestConfig.DefaultConsistency().
	Consistency types.Consistency `json:"consistency"`

	// Namespace is used on-premises only. It defines a namespace to use
	// for the request. It is optional.
	// If a namespace is specified in the table name for the request
	// (using the namespace:tablename format), that value will override this
	// setting.
	// If not set, the default namespace value configured for Client is used,
	// which is determined by RequestConfig.DefaultNamespace().
	// This is only available with on-premises installations using NoSQL
	// Server versions 23.3 and above.
	Namespace string `json:"namespace,omitempty"`

	common.InternalRequestData
}

type GetResult struct {
	Capacity

	// Value represents the value of the returned row, or nil if the row does not exist.
	Value *types.MapValue `json:"value"`

	// Version represents the version of the row if the operation was
	// successful, or nil if the row does not exist.
	Version types.Version `json:"version"`

	// ExpirationTime represents the expiration time of the row.
	// A zero value of time.Time indicates that the row does not expire.
	// This value is valid only if the operation successfully returned a row,
	// which means the returned Value is non-nil.
	ExpirationTime time.Time `json:"expirationTime"`

	// ModificationTime represents the modification time of an existing row.
	// Its value is in milliseconds since January 1 1970.
	// Added in SDK Version 1.3.0
	ModificationTime int64 `json:"modificationTime"`

	DelayInfo
}

type GetTableRequest struct {
	// TableName specifies the name of table.
	// It is required and must be non-empty.
	TableName string `json:"tableName"`

	// OperationID specifies the operation id to use for the request.
	// The operation id can be obtained via TableResult.OperationID.
	//
	// It is optional.
	// If set to a non-empty string, it represents an asynchronous table
	// operation that may be in progress. It is used to examine the result of
	// the operation and if the operation has failed, an error will be returned
	// in response to a Client.GetTable() operation. If the operation is in
	// progress or has completed successfully, the state of the table is
	// returned.
	OperationID string `json:"operationID,omitempty"`

	// Timeout specifies the timeout value for the request.
	// It is optional.
	// If set, it must be greater than or equal to 1 millisecond, otherwise an
	// IllegalArgument error will be returned.
	// If not set, the default timeout value configured for Client is used,
	// which is determined by RequestConfig.DefaultRequestTimeout().
	Timeout time.Duration `json:"timeout"`

	// Namespace is used on-premises only. It defines a namespace to use
	// for the request. It is optional.
	// If a namespace is specified in the table name for the request
	// (using the namespace:tablename format), that value will override this
	// setting.
	// If not set, the default namespace value configured for Client is used,
	// which is determined by RequestConfig.DefaultNamespace().
	// This is only available with on-premises installations using NoSQL
	// Server versions 23.3 and above.
	Namespace string `json:"namespace,omitempty"`

	common.InternalRequestData
}

type IndexInfo struct {
	// IndexName represents the name of index.
	IndexName string `json:"indexName"`

	// FieldNames represents a slice of string that contains names of fields
	// that constitute the index.
	FieldNames []string `json:"fieldNames"`

	// FieldTypes represents a slice of string that contains types of fields
	// that constitute the index.
	// The type is only non-null if the index is on a field of type JSON and
	// is explicitly typed. If using a server that does not support this
	// information, this will be null
	// Added in SDK Version 1.4.0
	FieldTypes []string `json:"fieldTypes"`
}

type ListTablesRequest struct {
	// StartIndex specifies the index to use to start returning table names.
	// This is related to the ListTablesResult.LastIndexReturned from a previous
	// request and can be used to page table names.
	//
	// It is optional.
	// If not set, the list starts at index 0.
	StartIndex uint `json:"startIndex,omitempty"`

	// Limit specifies the maximum number of tables to return in the operation.
	//
	// It is optional.
	// If not set, there is no limit.
	Limit uint `json:"limit,omitempty"`

	// Namespace is used on-premises only. It defines a namespace to use
	// for the request. It is optional.
	// If a namespace is specified in the table name for the request
	// (using the namespace:tablename format), that value will override this
	// setting.
	// If not set, the default namespace value configured for Client is used,
	// which is determined by RequestConfig.DefaultNamespace().
	// This is only available with on-premises installations using NoSQL
	// Server versions 23.3 and above.
	Namespace string `json:"namespace,omitempty"`

	// Timeout specifies the timeout value for the request.
	// It is optional.
	// If set, it must be greater than or equal to 1 millisecond, otherwise an
	// IllegalArgument error will be returned.
	// If not set, the default timeout value configured for Client is used,
	// which is determined by RequestConfig.DefaultRequestTimeout().
	Timeout time.Duration `json:"timeout"`

	common.InternalRequestData
}

type ListTablesResult struct {
	DelayInfo

	// Tables represents a slice of string that contains table names returned
	// by the operation, in alphabetical order.
	Tables []string `json:"tables"`

	// LastIndexReturnedthe represents index of the last table name returned.
	// This can be provided to ListTablesRequest.StartIndex to be used as a
	// starting point for listing tables.
	LastIndexReturned uint `json:"lastIndexReturned"`
	// contains filtered or unexported fields
}

type LoggingConfig struct {

	// Configurations for the logger.
	// If this is not set, use logger.DefaultLogger unless DisableLogging is set.
	*logger.Logger

	// DisableLogging represents whether logging is disabled.
	DisableLogging bool `json:"disableLogging,omitempty"`
}

type MultiDeleteRequest struct {
	// TableName specifies the name of table for the request.
	// It is required and must be non-empty.
	TableName string `json:"tableName"`

	// Key specifies the partial key used for the request.
	// It is required and must be non-nil.
	Key *types.MapValue `json:"key"`

	// ContinuationKey specifies the continuation key to use to continue the operation.
	ContinuationKey []byte `json:"continuationKey,omitempty"`

	// FieldRange specifies the FieldRange to be used for the operation.
	// It is optional, but required to delete a specific range of rows.
	FieldRange *types.FieldRange `json:"fieldRange,omitempty"`

	// MaxWriteKB specifies the limit on the total KB write during this operation.
	//
	// It is optional and has no effect for on-premise.
	//
	// When use for cloud service, if this value is not set, or set to 0, there
	// is no application-defined limit. This value can only reduce the system
	// defined limit. An attempt to increase the limit beyond the system defined
	// limit will cause an IllegalArgument error.
	MaxWriteKB uint `json:"maxWriteKB,omitempty"`

	// Timeout specifies the timeout value for the request.
	// It is optional.
	// If set, it must be greater than or equal to 1 millisecond, otherwise an
	// IllegalArgument error will be returned.
	// If not set, the default timeout value configured for Client is used,
	// which is determined by RequestConfig.DefaultRequestTimeout().
	Timeout time.Duration `json:"timeout"`

	// Durability is currently only used in On-Prem installations.
	// Added in SDK Version 1.3.0
	Durability types.Durability `json:"durability"`

	// Namespace is used on-premises only. It defines a namespace to use
	// for the request. It is optional.
	// If a namespace is specified in the table name for the request
	// (using the namespace:tablename format), that value will override this
	// setting.
	// If not set, the default namespace value configured for Client is used,
	// which is determined by RequestConfig.DefaultNamespace().
	// This is only available with on-premises installations using NoSQL
	// Server versions 23.3 and above.
	Namespace string `json:"namespace,omitempty"`

	common.InternalRequestData
}

type MultiDeleteResult struct {
	Capacity
	DelayInfo

	// ContinuationKey represents the continuation key where the next
	// MultiDelete request resumes from.
	ContinuationKey []byte `json:"continuationKey"`

	// NumDeleted represents the number of rows deleted from the table.
	NumDeleted int `json:"numDeleted"`
}

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

type OperationResult struct {
	// WriteResult is used to get the information about the existing row such as
	// ExistingValue and ExistingVersion on operation failure.
	WriteResult

	// Success represents whether the operation succeeded.
	// A put or delete operation may fail if the condition is not matched.
	Success bool `json:"success"`

	// Version represents the version of the new row for put operation, or nil
	// if the put operation did not succeed or the operation is a delete operation.
	Version types.Version `json:"version"`

	// GeneratedValue represents the value generated if the operation
	// created a new value for an identity column or string as uuid
	// column. If a value was generated for the column, it is non-nil,
	// otherwise it is nil.
	//
	// This value is only valid for a put operation on a table with an identity
	// column.
	GeneratedValue types.FieldValue `json:"generatedValue"`
}

type PrepareRequest struct {
	// Statement specifies a query statement.
	// It is required and must be non-empty.
	Statement string `json:"statement"`

	// GetQueryPlan specifies whether to include the query execution plan in
	// the PrepareResult returned for this request.
	GetQueryPlan bool `json:"getQueryPlan"`

	// GetQuerySchema specifies whether the JSON value of the query result schema
	// for the query should be included in the PrepareResult returned for this request.
	// Added in SDK Version 1.4.0
	GetQuerySchema bool `json:"getQuerySchema"`

	// Timeout specifies the timeout value for the request.
	// It is optional.
	// If set, it must be greater than or equal to 1 millisecond, otherwise an
	// IllegalArgument error will be returned.
	// If not set, the default timeout value configured for Client is used,
	// which is determined by RequestConfig.DefaultRequestTimeout().
	Timeout time.Duration `json:"timeout"`

	// Namespace is used on-premises only. It defines a namespace to use
	// for the request. It is optional.
	// If a namespace is specified in the table name in the SQL query string
	// (using the namespace:tablename format), that value will override this
	// setting.
	// If not set, the default namespace value configured for Client is used,
	// which is determined by RequestConfig.DefaultNamespace().
	// This is only available with on-premises installations using NoSQL
	// Server versions 23.3 and above.
	Namespace string `json:"namespace,omitempty"`

	common.InternalRequestData
}

type PrepareResult struct {
	Capacity
	DelayInfo

	// PreparedStatement represents the value of the prepared statement.
	PreparedStatement PreparedStatement `json:"preparedStatement"`
}

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

type PutRequest struct {
	// TableName specifies the name of table which the row to put into.
	// It is required and must be non-empty.
	TableName string `json:"tableName"`

	// Value specifies the value of the row to put.
	// It is required and must be non-nil.
	Value *types.MapValue `json:"value"`

	// PutOption specifies the put option for the operation.
	//
	// It is optional and performs an unconditional put by default.
	// If set, it must be types.PutIfAbsent, types.PutIfPresent or types.PutIfVersion.
	PutOption types.PutOption `json:"putOption"`

	// ReturnRow specifies whether information about the existing row should be
	// returned on failure because of a version mismatch or failure of a
	// PutIfAbsent operation.
	ReturnRow bool `json:"returnRow"`

	// TTL specifies the time to live (TTL) value, causing the time to live on
	// the row to be set to the specified value on put.
	// It is optional.
	TTL *types.TimeToLive `json:"ttl"`

	// UseTableTTL specifies whether to use the table's default TTL for the row.
	// If true, and there is an existing row, causes the operation to update
	// the time to live (TTL) value of the row based on the table's default
	// TTL if set. If the table has no default TTL this setting has no effect.
	// By default updating an existing row has no effect on its TTL.
	UseTableTTL bool `json:"useTableTTL"`

	// MatchVersion specifies the desired version to use for a conditional put
	// operation that uses the PutIfVersion option.
	// The Version is usually obtained from GetResult.Version or other method
	// that returns a Version. When set, the put operation will succeed only if
	// the row exists and its Version matches the one specified.
	// This condition exists to allow an application to ensure that it is
	// updating a row in an atomic read-modify-write cycle.
	//
	// Using this mechanism incurs additional cost.
	MatchVersion types.Version `json:"matchVersion,omitempty"`

	// ExactMatch specifies whether the provided Value must be an exact match
	// for the table schema. An exact match means that there are no required
	// fields missing and that there are no extra, unknown fields.
	// If set to true, and the provided Value does not match the table schema
	// exactly, the operation will fail.
	// The default behavior is to not require an exact match.
	ExactMatch bool `json:"exactMatch"`

	// IdentityCacheSize specifies the number of generated identity values that
	// are requested from the server during a put.
	// This takes precedence over the DDL identity CACHE option that was set
	// during creation of the identity column.
	// If this is set to a value that is less than or equal to 0, the DDL identity
	// CACHE value is used.
	IdentityCacheSize int `json:"identityCacheSize"`

	// Timeout specifies the timeout value for the request.
	// It is optional.
	// If set, it must be greater than or equal to 1 millisecond, otherwise an
	// IllegalArgument error will be returned.
	// If not set, the default timeout value configured for Client is used,
	// which is determined by RequestConfig.DefaultRequestTimeout().
	Timeout time.Duration `json:"timeout"`

	// Durability is currently only used in On-Prem installations.
	// Added in SDK Version 1.3.0
	Durability types.Durability `json:"durability"`

	// Namespace is used on-premises only. It defines a namespace to use
	// for the request. It is optional.
	// If a namespace is specified in the table name for the request
	// (using the namespace:tablename format), that value will override this
	// setting.
	// If not set, the default namespace value configured for Client is used,
	// which is determined by RequestConfig.DefaultNamespace().
	// This is only available with on-premises installations using NoSQL
	// Server versions 23.3 and above.
	Namespace string `json:"namespace,omitempty"`

	common.InternalRequestData
	// contains filtered or unexported fields
}

type PutResult struct {
	Capacity
	DelayInfo

	// WriteResult is used to get the information about the existing row such as
	// ExistingValue and ExistingVersion on operation failure.
	WriteResult

	// Version represents the version of the new row if the operation was
	// successful. If the operation failed nil is returned.
	Version types.Version `json:"version"`

	// GeneratedValue represents the value generated if the operation
	// created a new value for an identity column or string as uuid
	// column. If a value was generated for the column, it is non-nil,
	// otherwise it is nil.
	GeneratedValue types.FieldValue `json:"generatedValue"`
}

type QueryRequest struct {
	// Statement specifies a query statement.
	Statement string `json:"statement,omitempty"`

	// PreparedStatement specifies the prepared query statement.
	PreparedStatement *PreparedStatement `json:"preparedStatement,omitempty"`

	// Limit specifies the limit on number of items returned by the operation.
	// This allows an operation to return less than the default amount of data.
	Limit uint `json:"limit,omitempty"`

	// MaxReadKB specifies the limit on the total data read during this operation, in KB.
	//
	// For cloud service, this value can only reduce the system defined limit.
	// An attempt to increase the limit beyond the system defined limit will
	// cause an IllegalArgument error. This limit is independent of read units
	// consumed by the operation.
	//
	// It is recommended that for tables with relatively low provisioned read
	// throughput that this limit be reduced to less than or equal to one half
	// of the provisioned throughput in order to avoid or reduce throttling
	// errors.
	MaxReadKB uint `json:"maxReadKB,omitempty"`

	// MaxWriteKB specifies the limit on the total data written during this operation, in KB.
	//
	// This limit is independent of write units consumed by the operation.
	MaxWriteKB int `json:"maxWriteKB"`

	// MaxMemoryConsumption specifies the maximum number of memory in bytes that
	// may be consumed by the query at the client for operations such as
	// duplicate elimination (which may be required due to the use of an index
	// on an array or map) and sorting. Such operations may consume a lot of
	// memory as they need to cache the full result set or a large subset of
	// it at the client memory.
	//
	// The default value is 1GB.
	MaxMemoryConsumption int64 `json:"maxMemoryConsumption"`

	// FPArithSpec specifies the desired representation in terms of decimal
	// precision (number of digits) and rounding rules for the floating-point
	// values as arithematic operation results.
	//
	// The default is Decimal32, that is in IEEE 745R Decimal32 format.
	FPArithSpec *FPArithSpec

	// Consistency specifies desired consistency policy for the request.
	// It is optional.
	// If set, it must be either types.Absolute or types.Eventual, otherwise
	// an IllegalArgument error will be returned.
	// If not set, the default consistency value configured for Client is used,
	// which is determined by RequestConfig.DefaultConsistency().
	Consistency types.Consistency `json:"consistency,omitempty"`

	// Durability is currently only used in On-Prem installations.
	// This setting only applies if the query modifies
	// a row using an INSERT, UPSERT, or DELETE statement. If the query is
	// read-only it is ignored.
	// Added in SDK Version 1.4.0
	Durability types.Durability `json:"durability"`

	// Timeout specifies the timeout value for the request.
	// It is optional.
	// If set, it must be greater than or equal to 1 millisecond, otherwise an
	// IllegalArgument error will be returned.
	// If not set, the default timeout value configured for Client is used,
	// which is determined by RequestConfig.DefaultRequestTimeout().
	Timeout time.Duration `json:"timeout"`

	// TableName is only used in the cloud service.
	// TableName should be set to the table specified in the query.
	// If this is not set, cloud rate limiting may not work properly for the
	// query request.
	TableName string

	// Namespace is used on-premises only. It defines a namespace to use
	// for the request. It is optional.
	// If a namespace is specified in the table name in the SQL query string
	// (using the namespace:tablename format), that value will override this
	// setting.
	// If not set, the default namespace value configured for Client is used,
	// which is determined by RequestConfig.DefaultNamespace().
	// This is only available with on-premises installations using NoSQL
	// Server versions 23.3 and above.
	Namespace string `json:"namespace,omitempty"`

	common.InternalRequestData
	// contains filtered or unexported fields
}

type QueryResult struct {
	Capacity
	DelayInfo
	// contains filtered or unexported fields
}

type Request interface {
	common.InternalRequestDataInt
	// contains filtered or unexported methods
}

type RequestConfig struct {
	// RequestTimeout specifies a timeout value for requests.
	// This applies to any requests other than TableRequest.
	// If set, it must be greater than or equal to 1 millisecond.
	RequestTimeout time.Duration `json:"requestTimeout,omitempty"`

	// TableRequestTimeout specifies a timeout value for TableRequest.
	// If set, it must be greater than or equal to 1 millisecond.
	TableRequestTimeout time.Duration `json:"tableRequestTimeout,omitempty"`

	// SecurityInfoTimeout specifies a timeout value for retrieving security
	// information such as access tokens from authorization service.
	// This specifies a period of time waiting for security information to be available.
	// If set, it must be greater than or equal to 1 millisecond.
	SecurityInfoTimeout time.Duration `json:"securityInfoTimeout,omitempty"`

	// Consistency specifies a Consistency value for read requests, which
	// include GetRequest and QueryRequest.
	// If set, it must be either types.Eventual or types.Absolute.
	Consistency types.Consistency `json:"consistency,omitempty"`

	// Namespace is used on-premises only. It defines a namespace to use
	// for the request if it is not specified in the request struct itself or
	// in an SQL DDL/Query using the 'namespace:tablename' format.
	// This is only available with on-premises installations using NoSQL
	// Server versions 23.3 and above.
	Namespace string `json:"namespace,omitempty"`
}

type Result interface {
	// ConsumedCapacity is a function used to return the read, write throughput
	// consumed by an operation.
	ConsumedCapacity() (Capacity, error)

	Delayed() DelayInfo
}

type RetryHandler interface {
	// MaxNumRetries returns the maximum number of retries that this handler
	// instance will allow before the error is reported to the application.
	MaxNumRetries() uint

	// ShouldRetry indicates whether the request should continue to retry upon
	// receiving the specified error and having attempted the specified number
	// of retries.
	//
	// This method is used by the request handling system when a retryable error
	// is returned, to determine whether to perform a retry or not based on the
	// specified parameters.
	ShouldRetry(req Request, numRetries uint, err error) bool

	// Delay is called when a retryable error is reported. It is determined
	// that the request will be retried based on the return value of
	// ShouldRetry(). It provides a delay between retries. Most implementations
	// will sleep for some period of time. The method should not return until
	// the desired delay period has passed.
	//
	// Implementations should not busy-wait in a tight loop.
	Delay(req Request, numRetries uint, err error)
}

type SystemRequest struct {
	// Statement specifies the statement used for the operation.
	// It is required.
	Statement string `json:"statement"`

	// Timeout specifies the timeout value for the request.
	// It is optional.
	// If set, it must be greater than or equal to 1 millisecond, otherwise an
	// IllegalArgument error will be returned.
	// If not set, the default timeout value configured for Client is used,
	// which is determined by RequestConfig.DefaultTableRequestTimeout().
	Timeout time.Duration `json:"timeout"`

	common.InternalRequestData
}

type SystemResult struct {
	DelayInfo

	// State represents the current state of the operation.
	State types.OperationState `json:"state"`

	// OperationID represents the id for the operation if it was asynchronous.
	// This is an empty string if the request did not generate a new operation.
	// The value can be used in SystemStatusRequest.OperationID to find
	// potential errors resulting from the operation.
	//
	// This is only useful for the result of asynchronous operations.
	OperationID string `json:"operationID"`

	// Statement represents the statement used for the operation.
	Statement string `json:"statement"`

	// ResultString represents the result string for the operation.
	// This may be empty if the operation did not return a result, or may be
	// a JSON string that contains the result for the operation.
	ResultString string `json:"resultString"`
	// contains filtered or unexported fields
}

type SystemStatusRequest struct {
	// Statement specifies the statement used for the operation.
	// It is optional.
	Statement string `json:"statement"`

	// OperationID specifies the operation id to use for the request. The
	// operation id can be obtained via SystemResult.OperationID.
	//
	// It is required and represents an asynchronous operation that may be in
	// progress. It is used to examine the result of the operation and if the
	// operation has failed an error will be returned in response to a
	// Client.GetSystemStatus() operation. If the operation is in progress or
	// has completed successfully, the state of the operation is returned.
	OperationID string `json:"operationID,omitempty"`

	// Timeout specifies the timeout value for the request.
	// It is optional.
	// If set, it must be greater than or equal to 1 millisecond, otherwise an
	// IllegalArgument error will be returned.
	// If not set, the default timeout value configured for Client is used,
	// which is determined by RequestConfig.DefaultTableRequestTimeout().
	Timeout time.Duration `json:"timeout"`

	common.InternalRequestData
}

type TableLimits struct {
	// ReadUnits specifies the desired throughput of read operation in terms of
	// read units.
	ReadUnits uint `json:"readUnits"`

	// WriteUnits specifies the desired throughput of write operation in terms
	// of write units.
	WriteUnits uint `json:"writeUnits"`

	// StorageGB specifies the maximum amount of storage to be consumed by the
	// table, in gigabytes.
	StorageGB uint `json:"storageGB"`

	// CapacityMode specifies if the table is provisioned (the default) or
	// on demand.
	CapacityMode types.CapacityMode `json:"limitsMode"`
}

type TableRequest struct {
	// Statement specifies the statement for table relevant operations.
	// It is required for operations that manage table schema.
	Statement string `json:"statement"`

	// TableName specifies the name of an existing table.
	//
	// It is required for operations that change table limits of an existing table.
	// It should not be specified for other operations.
	TableName string `json:"tableName,omitempty"`

	// TableLimits specifies desired read/write throughput, storage limits, and
	// mode (provisioned or on demand) for the table.
	//
	// It is required for operations that create tables or change table limits.
	// It should not be specified for other operations.
	//
	// TableLimits is used for cloud service only.
	// It will be ignored if used for on-premise.
	TableLimits *TableLimits `json:"tableLimits,omitempty"`

	// FreeFormTags define the free-form tags to use for the operation.
	// FreeFormTags are used in only 2 cases: table creation statements and tag
	// modification operations.
	// They are not used for other DDL operations.
	// If tags are set for an on-premise service they are silently ignored.
	// Added in SDK version 1.4.0
	FreeFormTags *types.FreeFormTags

	// DefinedTags define the tags to use for the operation.
	// DefinedTags are used in only 2 cases: table creation statements and tag
	// modification operations.
	// They are not used for other DDL operations.
	// If tags are set for an on-premise service they are silently ignored.
	// Added in SDK version 1.4.0
	DefinedTags *types.DefinedTags

	// MatchETag defines an ETag in the request that must be matched for the operation
	// to proceed. The ETag must be non-null and have been returned in a
	// previous TableResult. This is a form of optimistic concurrency
	// control allowing an application to ensure no unexpected modifications
	// have been made to the table.
	// If set for an on-premise service the ETag is silently ignored.
	// Added in SDK version 1.4.0
	MatchETag string

	// Timeout specifies the timeout value for the request.
	// It is optional.
	// If set, it must be greater than or equal to 1 millisecond, otherwise an
	// IllegalArgument error will be returned.
	// If not set, the default timeout value configured for Client is used,
	// which is determined by RequestConfig.DefaultTableRequestTimeout().
	Timeout time.Duration `json:"timeout"`

	// Namespace is used on-premises only. It defines a namespace to use
	// for the request. It is optional.
	// If a namespace is specified in the table name for the request
	// (using the namespace:tablename format), that value will override this
	// setting.
	// If not set, the default namespace value configured for Client is used,
	// which is determined by RequestConfig.DefaultNamespace().
	// This is only available with on-premises installations using NoSQL
	// Server versions 23.3 and above.
	Namespace string `json:"namespace,omitempty"`

	common.InternalRequestData
}

type TableResult struct {
	DelayInfo

	// TableName represents the name of target table.
	TableName string `json:"tableName"`

	// compartmentOrNamespace is the compartment id (ocid) or namespace (if on-prem)
	CompartmentOrNamespace string

	// TableOcid is only used in the cloud service
	TableOcid string

	// State represents current state of the table.
	// A table in Active state or Updating state is usable for normal operation.
	// It is not permitted to perform table modification operations while the
	// table is in Updating state.
	State types.TableState `json:"state"`

	// Limits represents read/write throughput and storage limits for the table.
	Limits TableLimits `json:"limits"`

	// Schema represents table schema and any other metadata available for the table.
	// The returned schema may subject to change in future releases.
	Schema string `json:"schema"`

	// DDL represents the DDL (create table) statement used to create this table if
	// available. If the table has been altered since initial creation the
	// statement is also altered to reflect the current table schema.
	// The most reliable way to get the DDL statement is using GetTable
	// on an existing table.
	// Added in SDK Version 1.4.0
	DDL string `json:"ddl"`

	// OperationID represents the operation id for an asynchronous operation.
	// This is empty if the request did not generate a new operation. The value
	// can be used in GetTableRequest.OperationId to find potential errors
	// resulting from the operation.
	OperationID string `json:"operationID"`

	// FreeFormTags represent the free-form tags associated with the table, if any.
	// Cloud service only.
	// Added in SDK Version 1.4.0
	FreeFormTags *types.FreeFormTags

	// DefinedTags represent the defined tags associated with the table, if any.
	// Cloud service only.
	// Added in SDK Version 1.4.0
	DefinedTags *types.DefinedTags

	// MatchETag represents the matchETag associated with this table. The matchETag is an
	// opaque field that represents the current version of the table itself and
	// can be used in future table modification operations to only perform
	// them if the matchETag for the table has not changed. This is an
	// optimistic concurrency control mechanism.
	// Cloud service only.
	// Added in SDK Version 1.4.0
	MatchETag string `json:"matchETag"`
	// contains filtered or unexported fields
}

type TableUsage struct {
	// StartTime represents the start time for this usage record.
	StartTime time.Time `json:"startTime"`

	// EndTime represents the end time for this usage record.
	EndTime time.Time `json:"endTime"`

	// ReadUnits represents the number of read uits consumed during this period.
	ReadUnits int `json:"readUnits"`

	// WriteUnits represents the number of write uits consumed during this period.
	WriteUnits int `json:"writeUnits"`

	// StorageGB represents the amount of storage consumed by the table.
	// This information may be out of date as it is not maintained in real time.
	StorageGB int `json:"storageGB"`

	// ReadThrottleCount represents the number of read throttling exceptions on
	// this table in the time period.
	ReadThrottleCount int `json:"readThrottleCount"`

	// WriteThrottleCount represents the number of write throttling exceptions
	// on this table in the time period.
	WriteThrottleCount int `json:"writeThrottleCount"`

	// StorageThrottleCount represents the number of storage throttling
	// exceptions on this table in the time period.
	StorageThrottleCount int `json:"storageThrottleCount"`

	// MaxShardUsagePercent represents the percentage of allowed storage
	// usage for the shard with the highest usage percentage across all table
	// shards. This can be used as a gauge of total storage available as well as
	// a hint for key distribution across shards.
	// Added in SDK version 1.4.0
	MaxShardUsagePercent int `json:"maxShardUsagePercent"`
}

type TableUsageRequest struct {
	// TableName specifies the name of table for the request.
	// It is required and must be non-empty.
	TableName string `json:"tableName"`

	// StartTime specifies the start time to use for the request.
	// It is optional.
	// If no time range is set for this request the most recent complete usage
	// record is returned.
	StartTime time.Time `json:"startTime,omitempty"`

	// EndTime specifies the end time to use for the request.
	// It is optional.
	// If no time range is set for this request the most recent complete usage
	// record is returned.
	EndTime time.Time `json:"endTime,omitempty"`

	// Limit specifies the limit on the number of usage records desired.
	// It is optional.
	// If not set, or set to 0 there is no limit, but not all usage records may
	// be returned in a single request due to size limitations.
	Limit uint `json:"limit,omitempty"`

	// StartIndex sets the index to use to start returning usage records.
	// This is related to the TableUsageResult.LastReturnedIndex from a previous
	// request and can be used to page usage records.
	// If not set, the list starts at index 0.
	// Added in SDK version 1.4.0
	StartIndex int `json:"startIndex,omitempty"`

	// Timeout specifies the timeout value for the request.
	// It is optional.
	// If set, it must be greater than or equal to 1 millisecond, otherwise an
	// IllegalArgument error will be returned.
	// If not set, the default timeout value configured for Client is used,
	// which is determined by RequestConfig.DefaultRequestTimeout().
	Timeout time.Duration `json:"timeout"`

	// Namespace is used on-premises only. It defines a namespace to use
	// for the request. It is optional.
	// If a namespace is specified in the table name for the request
	// (using the namespace:tablename format), that value will override this
	// setting.
	// If not set, the default namespace value configured for Client is used,
	// which is determined by RequestConfig.DefaultNamespace().
	// This is only available with on-premises installations using NoSQL
	// Server versions 23.3 and above.
	Namespace string `json:"namespace,omitempty"`

	common.InternalRequestData
}

type TableUsageResult struct {
	DelayInfo

	// TableName represents table name used by the operation.
	TableName string `json:"tableName"`

	// UsageRecords represent a slice of usage records based on the parameters
	// of the TableUsageRequest used.
	UsageRecords []TableUsage `json:"usageRecords"`

	// LastIndexReturned indicates the index of the last usage record returned.
	// This can be provided to TableUsageRequest to indicate a starting point
	// for listing usage records.
	// Added in SDK 1.4.0
	LastIndexReturned int
	// contains filtered or unexported fields
}

type UserInfo struct {
	// ID represents user id.
	ID string

	// Name represents user name.
	Name string
}

type WriteMultipleRequest struct {
	// TableName specifies the name of table for the request.
	// This is now ignored: table name(s) are derived from sub-requests.
	TableName string `json:"tableName"`

	// Operations specifies a list of operations for the request.
	// Usually it should not be set explicitly, instead, use the AddPutRequest()
	// or AddDeleteRequest() methods to add the operations.
	Operations []*WriteOperation `json:"operations"`

	// Timeout specifies the timeout value for the request.
	// It is optional.
	// If set, it must be greater than or equal to 1 millisecond, otherwise an
	// IllegalArgument error will be returned.
	// If not set, the default timeout value configured for Client is used,
	// which is determined by RequestConfig.DefaultRequestTimeout().
	Timeout time.Duration `json:"timeout"`

	// Durability is currently only used in On-Prem installations.
	// Added in SDK Version 1.3.0
	Durability types.Durability `json:"durability"`

	// Namespace is used on-premises only. It defines a namespace to use
	// for the request. It is optional.
	// If a namespace is specified in the table name in the SQL query string
	// (using the namespace:tablename format), that value will override this
	// setting.
	// If not set, the default namespace value configured for Client is used,
	// which is determined by RequestConfig.DefaultNamespace().
	// This is only available with on-premises installations using NoSQL
	// Server versions 23.3 and above.
	// NOTE: unlike TableName, the Namespace in WriteMultipleRequest is used
	// as the namespace for all sub-requests. Namespaces in sub-requests will
	// be ignored.
	Namespace string `json:"namespace,omitempty"`

	common.InternalRequestData
	// contains filtered or unexported fields
}

type WriteMultipleResult struct {
	Capacity
	DelayInfo

	// ResultSet represents the list of execution results for the operations.
	ResultSet []OperationResult `json:"resultSet"`

	// FailedOperationIndex represents the index of failed operation that
	// results in the entire WriteMultiple operation aborting.
	FailedOperationIndex int `json:"failedOperationIndex"`
}

type WriteOperation struct {
	// AbortOnFail specifies whether to abort all operations that included in
	// the same WriteMultipleRequest when this operation fails.
	AbortOnFail bool `json:"abortOnFail"`

	// DeleteRequest specifies a delete operation.
	DeleteRequest *DeleteRequest `json:"deleteRequest,omitempty"`

	// PutRequest specifies a put operation.
	PutRequest *PutRequest `json:"putRequest,omitempty"`
}

type WriteResult struct {
	// ExistingVersion represents the Version of an existing row.
	ExistingVersion types.Version `json:"existingVersion"`

	// ExistingValue represents the Value of an existing row.
	ExistingValue *types.MapValue `json:"existingValue"`

	// ExistingModificationTime represents the modification time of an existing row.
	// Its value is in milliseconds since January 1 1970.
	// Added in SDK Version 1.3.0
	ExistingModificationTime int64 `json:"existingModificationTime"`
}