sqlv2

type ColumnInformation struct {
	// The name of the column.
	Name *string `json:"name" validate:"required"`

	// The data type of the column.
	Type *string `json:"type" validate:"required"`

	// Whether the column may contain NULL values.
	Nullable *bool `json:"nullable,omitempty"`
}

type GetSqlJobOptions struct {
	// ID of the SQL job for which information is to be retrieved. This ID is returned when an SQL job is submitted, and
	// when information about recently submitted SQL jobs is requested.
	JobID *string `validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type GetTableOptions struct {
	// Name of the catalog table for which information is to be retrieved. Table names are case-insensitive and must only
	// contain alphabetic and numeral characters, and underscore (_).
	TableName *string `validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ListSqlJobsOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ListTablesOptions struct {
	// A table name pattern for filtering the tables that should be listed. The pattern follows Hive syntax conventions and
	// can include asterisks as wildcards and vertical bars to separate alternatives.
	NamePattern *string

	// A table type for filtering the tables that should be listed, can be "table" or "view".
	Type *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

type SqlJobInfoFull struct {
	// Identifier for an SQL job.
	JobID *string `json:"job_id" validate:"required"`

	// Execution status of an SQL job.
	Status *string `json:"status" validate:"required"`

	// ID of the user who submitted an SQL job.
	UserID *string `json:"user_id" validate:"required"`

	// Timestamp indicating when an SQL job was accepted by the service.
	SubmitTime *strfmt.DateTime `json:"submit_time" validate:"required"`

	// The SQL query that the job processes.
	Statement *string `json:"statement" validate:"required"`

	// The service plan id of the instance.
	PlanID *string `json:"plan_id,omitempty"`

	// Format of the query result.
	ResultsetFormat *string `json:"resultset_format,omitempty"`

	// A URI that indicates where the query result is stored. This URI can be used as input for another SQL query. The
	// result comprises all objects that have a name with this URI as its prefix.
	ResultsetLocation *string `json:"resultset_location,omitempty"`

	// Timestamp indicating when the job finished processing.
	EndTime *strfmt.DateTime `json:"end_time,omitempty"`

	// Number of rows returned.
	RowsReturned *float64 `json:"rows_returned,omitempty"`

	// Number of rows read.
	RowsRead *float64 `json:"rows_read,omitempty"`

	// Number of bytes read.
	BytesRead *float64 `json:"bytes_read,omitempty"`

	// Number of objects skipped using index management.(Optional).
	ObjectsSkipped *float64 `json:"objects_skipped,omitempty"`

	// Number of objects qualified using index management.(Optional).
	ObjectsQualified *float64 `json:"objects_qualified,omitempty"`

	// An error that was encountered while processing the job.
	Error *string `json:"error,omitempty"`

	// Detailed information about the error.
	ErrorMessage *string `json:"error_message,omitempty"`

	// Suggests possible optimizations for a query.
	Hints []string `json:"hints,omitempty"`
}

type SqlJobInfoList struct {
	// The SQL jobs.
	Jobs []SqlJobInfoShort `json:"jobs" validate:"required"`
}

type SqlJobInfoShort struct {
	// Identifier for an SQL job.
	JobID *string `json:"job_id" validate:"required"`

	// Execution status of an SQL job.
	Status *string `json:"status" validate:"required"`

	// ID of the user who submitted an SQL job.
	UserID *string `json:"user_id,omitempty"`

	// Timestamp indicating when an SQL job was accepted by the service.
	SubmitTime *strfmt.DateTime `json:"submit_time,omitempty"`

	// Boolean indicating when an SQL job has an improvement hint.
	HasHints *bool `json:"has_hints,omitempty"`
}

type SqlV2 struct {
	Service *core.BaseService

	// The cloud resource name (CRN) of the SQL query service instance.
	InstanceCrn *string
}

type SqlV2Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator

	// The cloud resource name (CRN) of the SQL query service instance.
	InstanceCrn *string `validate:"required"`
}

type SubmitSqlJobOptions struct {
	// This is the SQL query to be submitted. The table names specified in its FROM clause must correspond to files in one
	// or more *IBM Cloud Object Storage* instances. The INTO clause of the query indicates the endpoint, bucket, and
	// (optionally) subfolder in *IBM Cloud Object Storage* in which the query result is to be stored. Within the specified
	// target, each result is stored in a separate subfolder with a name that indicates the job ID. The job ID of a query
	// is returned by the GET endpoint.
	Statement *string `validate:"required"`

	// This field provides an alternative way to specify the target URI for a query. It is supported to preserve backward
	// compatibility and will be removed in a future API version. Use the INTO clause of the SQL query to specify the
	// target URI instead.
	ResultsetTarget *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

type TableInformation struct {
	// The name of a catalog table.
	Name *string `json:"name" validate:"required"`

	// The type of a catalog table (for example, "TABLE" or "VIEW").
	Type *string `json:"type" validate:"required"`

	// The columns of the table.
	Columns []ColumnInformation `json:"columns" validate:"required"`
}

type TableList struct {
	// The table names.
	Tables []string `json:"tables" validate:"required"`

	// Metadata about the returned tables.
	TablesMetadata []TableMetadata `json:"tables_metadata" validate:"required"`
}

type TableMetadata struct {
	// The name of a catalog table.
	Name *string `json:"name" validate:"required"`

	// The type of a catalog table (for example, "TABLE" or "VIEW").
	Type *string `json:"type" validate:"required"`
}