gogol-bigquery-0.0.1: Google BigQuery SDK.

Copyright(c) 2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.BigQuery.Types

Contents

Description

 

Synopsis

Service Configuration

bigQueryService :: Service Source

Default request referring to version v2 of the BigQuery API. This contains the host and root path used as a starting point for constructing service requests.

OAuth Scopes

cloudPlatformReadOnlyScope :: OAuthScope Source

View your data across Google Cloud Platform services

cloudPlatformScope :: OAuthScope Source

View and manage your data across Google Cloud Platform services

devstorageReadOnlyScope :: OAuthScope Source

View your data in Google Cloud Storage

bigqueryInsertdataScope :: OAuthScope Source

Insert data into Google BigQuery

devstorageReadWriteScope :: OAuthScope Source

Manage your data in Google Cloud Storage

bigqueryScope :: OAuthScope Source

View and manage your data in Google BigQuery

devstorageFullControlScope :: OAuthScope Source

Manage your data and permissions in Google Cloud Storage

JobReference

data JobReference Source

Instances

jobReference :: JobReference Source

Creates a value of JobReference with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

jrJobId :: Lens' JobReference (Maybe Text) Source

Required
The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.

jrProjectId :: Lens' JobReference (Maybe Text) Source

Required
The ID of the project containing this job.

TableList

data TableList Source

Instances

tableList :: TableList Source

Creates a value of TableList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tlTotalItems :: Lens' TableList (Maybe Int32) Source

The total number of tables in the dataset.

tlEtag :: Lens' TableList (Maybe Text) Source

A hash of this page of results.

tlNextPageToken :: Lens' TableList (Maybe Text) Source

A token to request the next page of results.

tlKind :: Lens' TableList Text Source

The type of list.

tlTables :: Lens' TableList [TableListTablesItem] Source

Tables in the requested dataset.

DataSetListDataSetsItem

data DataSetListDataSetsItem Source

Instances

dataSetListDataSetsItem :: DataSetListDataSetsItem Source

Creates a value of DataSetListDataSetsItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dsldsiFriendlyName :: Lens' DataSetListDataSetsItem (Maybe Text) Source

A descriptive name for the dataset, if one exists.

dsldsiKind :: Lens' DataSetListDataSetsItem Text Source

The resource type. This property always returns the value "bigquery#dataset".

dsldsiDataSetReference :: Lens' DataSetListDataSetsItem (Maybe DataSetReference) Source

The dataset reference. Use this property to access specific parts of the dataset's ID, such as project ID or dataset ID.

dsldsiId :: Lens' DataSetListDataSetsItem (Maybe Text) Source

The fully-qualified, unique, opaque ID of the dataset.

TableDataList

data TableDataList Source

Instances

tableDataList :: TableDataList Source

Creates a value of TableDataList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tdlEtag :: Lens' TableDataList (Maybe Text) Source

A hash of this page of results.

tdlKind :: Lens' TableDataList Text Source

The resource type of the response.

tdlRows :: Lens' TableDataList [TableRow] Source

Rows of results.

tdlPageToken :: Lens' TableDataList (Maybe Text) Source

A token used for paging results. Providing this token instead of the startIndex parameter can help you retrieve stable results when an underlying table is changing.

tdlTotalRows :: Lens' TableDataList (Maybe Int64) Source

The total number of rows in the complete table.

JobConfigurationTableCopy

data JobConfigurationTableCopy Source

Instances

jobConfigurationTableCopy :: JobConfigurationTableCopy Source

Creates a value of JobConfigurationTableCopy with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

jctcDestinationTable :: Lens' JobConfigurationTableCopy (Maybe TableReference) Source

Required
The destination table

jctcWriteDisPosition :: Lens' JobConfigurationTableCopy (Maybe Text) Source

Optional
Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.

jctcSourceTables :: Lens' JobConfigurationTableCopy [TableReference] Source

Pick one
Source tables to copy.

jctcCreateDisPosition :: Lens' JobConfigurationTableCopy (Maybe Text) Source

Optional
Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.

jctcSourceTable :: Lens' JobConfigurationTableCopy (Maybe TableReference) Source

Pick one
Source table to copy.

TableListTablesItem

data TableListTablesItem Source

Instances

tableListTablesItem :: TableListTablesItem Source

Creates a value of TableListTablesItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tltiTableReference :: Lens' TableListTablesItem (Maybe TableReference) Source

A reference uniquely identifying the table.

tltiFriendlyName :: Lens' TableListTablesItem (Maybe Text) Source

The user-friendly name for this table.

tltiKind :: Lens' TableListTablesItem Text Source

The resource type.

tltiId :: Lens' TableListTablesItem (Maybe Text) Source

An opaque ID of the table

tltiType :: Lens' TableListTablesItem (Maybe Text) Source

The type of table. Possible values are: TABLE, VIEW.

TableSchema

data TableSchema Source

Instances

tableSchema :: TableSchema Source

Creates a value of TableSchema with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tsFields :: Lens' TableSchema [TableFieldSchema] Source

Describes the fields in a table.

ProjectList

data ProjectList Source

Instances

projectList :: ProjectList Source

Creates a value of ProjectList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

plTotalItems :: Lens' ProjectList (Maybe Int32) Source

The total number of projects in the list.

plEtag :: Lens' ProjectList (Maybe Text) Source

A hash of the page of results

plNextPageToken :: Lens' ProjectList (Maybe Text) Source

A token to request the next page of results.

plKind :: Lens' ProjectList Text Source

The type of list.

plProjects :: Lens' ProjectList [ProjectListProjectsItem] Source

Projects to which you have at least READ access.

JobStatistics

data JobStatistics Source

Instances

jobStatistics :: JobStatistics Source

Creates a value of JobStatistics with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

jsCreationTime :: Lens' JobStatistics (Maybe Int64) Source

Output-only
Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.

jsStartTime :: Lens' JobStatistics (Maybe Int64) Source

Output-only
Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.

jsLoad :: Lens' JobStatistics (Maybe JobStatistics3) Source

Output-only
Statistics for a load job.

jsTotalBytesProcessed :: Lens' JobStatistics (Maybe Int64) Source

Output-only
[Deprecated] Use the bytes processed in the query statistics instead.

jsEndTime :: Lens' JobStatistics (Maybe Int64) Source

Output-only
End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.

jsQuery :: Lens' JobStatistics (Maybe JobStatistics2) Source

Output-only
Statistics for a query job.

jsExtract :: Lens' JobStatistics (Maybe JobStatistics4) Source

Output-only
Statistics for an extract job.

DataSet

data DataSet Source

Instances

dataSet :: DataSet Source

Creates a value of DataSet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dsCreationTime :: Lens' DataSet (Maybe Int64) Source

Output-only
The time when this dataset was created, in milliseconds since the epoch.

dsAccess :: Lens' DataSet [DataSetAccessItem] Source

Optional
An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;

dsEtag :: Lens' DataSet (Maybe Text) Source

Output-only
A hash of the resource.

dsLocation :: Lens' DataSet (Maybe Text) Source

Experimental
The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.

dsFriendlyName :: Lens' DataSet (Maybe Text) Source

Optional
A descriptive name for the dataset.

dsKind :: Lens' DataSet Text Source

Output-only
The resource type.

dsLastModifiedTime :: Lens' DataSet (Maybe Int64) Source

Output-only
The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.

dsDataSetReference :: Lens' DataSet (Maybe DataSetReference) Source

Required
A reference that identifies the dataset.

dsSelfLink :: Lens' DataSet (Maybe Text) Source

Output-only
A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.

dsId :: Lens' DataSet (Maybe Text) Source

Output-only
The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.

dsDefaultTableExpirationMs :: Lens' DataSet (Maybe Int64) Source

Experimental
The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.

dsDescription :: Lens' DataSet (Maybe Text) Source

Optional
A user-friendly description of the dataset.

ExternalDataConfiguration

data ExternalDataConfiguration Source

Instances

externalDataConfiguration :: ExternalDataConfiguration Source

Creates a value of ExternalDataConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

edcIgnoreUnknownValues :: Lens' ExternalDataConfiguration (Maybe Bool) Source

Optional
Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names

edcCompression :: Lens' ExternalDataConfiguration (Maybe Text) Source

Optional
The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE.

edcSourceFormat :: Lens' ExternalDataConfiguration (Maybe Text) Source

Required
The data format. For CSV files, specify "CSV". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON".

edcSchema :: Lens' ExternalDataConfiguration (Maybe TableSchema) Source

Required
The schema for the data.

edcMaxBadRecords :: Lens' ExternalDataConfiguration (Maybe Int32) Source

Optional
The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid.

edcSourceURIs :: Lens' ExternalDataConfiguration [Text] Source

Required
The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources, plus an additional limit of 10 GB maximum size across all URIs.

edcCSVOptions :: Lens' ExternalDataConfiguration (Maybe CSVOptions) Source

Additional properties to set if sourceFormat is set to CSV.

TableReference

data TableReference Source

Instances

tableReference :: TableReference Source

Creates a value of TableReference with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

trDataSetId :: Lens' TableReference (Maybe Text) Source

Required
The ID of the dataset containing this table.

trProjectId :: Lens' TableReference (Maybe Text) Source

Required
The ID of the project containing this table.

trTableId :: Lens' TableReference (Maybe Text) Source

Required
The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

TableFieldSchema

data TableFieldSchema Source

Instances

tableFieldSchema :: TableFieldSchema Source

Creates a value of TableFieldSchema with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tfsMode :: Lens' TableFieldSchema (Maybe Text) Source

Optional
The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

tfsName :: Lens' TableFieldSchema (Maybe Text) Source

Required
The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

tfsType :: Lens' TableFieldSchema (Maybe Text) Source

Required
The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).

tfsDescription :: Lens' TableFieldSchema (Maybe Text) Source

Optional
The field description. The maximum length is 16K characters.

tfsFields :: Lens' TableFieldSchema [TableFieldSchema] Source

Optional
Describes the nested schema fields if the type property is set to RECORD.

GetQueryResultsResponse

data GetQueryResultsResponse Source

Instances

getQueryResultsResponse :: GetQueryResultsResponse Source

Creates a value of GetQueryResultsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

gqrrJobReference :: Lens' GetQueryResultsResponse (Maybe JobReference) Source

Reference to the BigQuery Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).

gqrrEtag :: Lens' GetQueryResultsResponse (Maybe Text) Source

A hash of this response.

gqrrKind :: Lens' GetQueryResultsResponse Text Source

The resource type of the response.

gqrrSchema :: Lens' GetQueryResultsResponse (Maybe TableSchema) Source

The schema of the results. Present only when the query completes successfully.

gqrrTotalBytesProcessed :: Lens' GetQueryResultsResponse (Maybe Int64) Source

The total number of bytes processed for this query.

gqrrRows :: Lens' GetQueryResultsResponse [TableRow] Source

An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully.

gqrrPageToken :: Lens' GetQueryResultsResponse (Maybe Text) Source

A token used for paging results.

gqrrTotalRows :: Lens' GetQueryResultsResponse (Maybe Word64) Source

The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully.

gqrrErrors :: Lens' GetQueryResultsResponse [ErrorProto] Source

Output-only
All errors and warnings encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.

gqrrJobComplete :: Lens' GetQueryResultsResponse (Maybe Bool) Source

Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.

gqrrCacheHit :: Lens' GetQueryResultsResponse (Maybe Bool) Source

Whether the query result was fetched from the query cache.

DataSetList

data DataSetList Source

Instances

dataSetList :: DataSetList Source

Creates a value of DataSetList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dslEtag :: Lens' DataSetList (Maybe Text) Source

A hash value of the results page. You can use this property to determine if the page has changed since the last request.

dslNextPageToken :: Lens' DataSetList (Maybe Text) Source

A token that can be used to request the next results page. This property is omitted on the final results page.

dslKind :: Lens' DataSetList Text Source

The list type. This property always returns the value "bigquery#datasetList".

dslDataSets :: Lens' DataSetList [DataSetListDataSetsItem] Source

An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project.

QueryRequest

data QueryRequest Source

Instances

queryRequest :: QueryRequest Source

Creates a value of QueryRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

qrUseQueryCache :: Lens' QueryRequest Bool Source

Optional
Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true.

qrPreserveNulls :: Lens' QueryRequest (Maybe Bool) Source

Deprecated
This property is deprecated.

qrKind :: Lens' QueryRequest Text Source

The resource type of the request.

qrQuery :: Lens' QueryRequest (Maybe Text) Source

Required
A query string, following the BigQuery query syntax, of the query to execute. Example: "SELECT count(f1) FROM
myProjectId:myDatasetId.myTableId
".

qrTimeoutMs :: Lens' QueryRequest (Maybe Word32) Source

Optional
How long to wait for the query to complete, in milliseconds, before the request times out and returns. Note that this is only a timeout for the request, not the query. If the query takes longer to run than the timeout value, the call returns without any results and with the 'jobComplete' flag set to false. You can call GetQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds).

qrDryRun :: Lens' QueryRequest (Maybe Bool) Source

Optional
If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false.

qrMaxResults :: Lens' QueryRequest (Maybe Word32) Source

Optional
The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies.

qrDefaultDataSet :: Lens' QueryRequest (Maybe DataSetReference) Source

Optional
Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be qualified in the format 'datasetId.tableId'.

JobsListProjection

data JobsListProjection Source

Restrict information returned to a set of selected fields

Constructors

Full

full Includes all job data

Minimal

minimal Does not include the job configuration

Instances

JobStatistics4

data JobStatistics4 Source

Instances

jobStatistics4 :: JobStatistics4 Source

Creates a value of JobStatistics4 with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

jsDestinationURIFileCounts :: Lens' JobStatistics4 [Int64] Source

Output-only
Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.

ProjectReference

data ProjectReference Source

Instances

projectReference :: ProjectReference Source

Creates a value of ProjectReference with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

prProjectId :: Lens' ProjectReference (Maybe Text) Source

Required
ID of the project. Can be either the numeric ID or the assigned ID of the project.

JobConfigurationLoad

data JobConfigurationLoad Source

Instances

jobConfigurationLoad :: JobConfigurationLoad Source

Creates a value of JobConfigurationLoad with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

jclSkipLeadingRows :: Lens' JobConfigurationLoad (Maybe Int32) Source

Optional
The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.

jclProjectionFields :: Lens' JobConfigurationLoad [Text] Source

Experimental
If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.

jclDestinationTable :: Lens' JobConfigurationLoad (Maybe TableReference) Source

Required
The destination table to load the data into.

jclWriteDisPosition :: Lens' JobConfigurationLoad (Maybe Text) Source

Optional
Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.

jclAllowJaggedRows :: Lens' JobConfigurationLoad (Maybe Bool) Source

Optional
Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.

jclSchemaInline :: Lens' JobConfigurationLoad (Maybe Text) Source

Deprecated
The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".

jclIgnoreUnknownValues :: Lens' JobConfigurationLoad (Maybe Bool) Source

Optional
Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names

jclCreateDisPosition :: Lens' JobConfigurationLoad (Maybe Text) Source

Optional
Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.

jclSchemaInlineFormat :: Lens' JobConfigurationLoad (Maybe Text) Source

Deprecated
The format of the schemaInline property.

jclAllowQuotedNewlines :: Lens' JobConfigurationLoad (Maybe Bool) Source

Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

jclSourceFormat :: Lens' JobConfigurationLoad (Maybe Text) Source

Optional
The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". The default value is CSV.

jclSchema :: Lens' JobConfigurationLoad (Maybe TableSchema) Source

Optional
The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data.

jclQuote :: Lens' JobConfigurationLoad Text Source

Optional
The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

jclMaxBadRecords :: Lens' JobConfigurationLoad (Maybe Int32) Source

Optional
The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid.

jclSourceURIs :: Lens' JobConfigurationLoad [Text] Source

Required
The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name.

jclEncoding :: Lens' JobConfigurationLoad (Maybe Text) Source

Optional
The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

jclFieldDelimiter :: Lens' JobConfigurationLoad (Maybe Text) Source

Optional
The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').

JobsListStateFilter

data JobsListStateFilter Source

Filter for job state

Constructors

Done

done Finished jobs

Pending

pending Pending jobs

Running

running Running jobs

Instances

DataSetReference

data DataSetReference Source

Instances

dataSetReference :: DataSetReference Source

Creates a value of DataSetReference with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dsrDataSetId :: Lens' DataSetReference (Maybe Text) Source

Required
A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

dsrProjectId :: Lens' DataSetReference (Maybe Text) Source

Optional
The ID of the project containing this dataset.

TableDataInsertAllRequest

data TableDataInsertAllRequest Source

Instances

tableDataInsertAllRequest :: TableDataInsertAllRequest Source

Creates a value of TableDataInsertAllRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tdiarKind :: Lens' TableDataInsertAllRequest Text Source

The resource type of the response.

tdiarIgnoreUnknownValues :: Lens' TableDataInsertAllRequest (Maybe Bool) Source

Optional
Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false, which treats unknown values as errors.

tdiarRows :: Lens' TableDataInsertAllRequest [TableDataInsertAllRequestRowsItem] Source

The rows to insert.

tdiarSkipInvalidRows :: Lens' TableDataInsertAllRequest (Maybe Bool) Source

Optional
Insert all valid rows of a request, even if invalid rows exist. The default value is false, which causes the entire request to fail if any invalid rows exist.

ProjectListProjectsItem

data ProjectListProjectsItem Source

Instances

projectListProjectsItem :: ProjectListProjectsItem Source

Creates a value of ProjectListProjectsItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

plpiFriendlyName :: Lens' ProjectListProjectsItem (Maybe Text) Source

A descriptive name for this project.

plpiKind :: Lens' ProjectListProjectsItem Text Source

The resource type.

plpiProjectReference :: Lens' ProjectListProjectsItem (Maybe ProjectReference) Source

A unique reference to this project.

plpiId :: Lens' ProjectListProjectsItem (Maybe Text) Source

An opaque ID of this project.

plpiNumericId :: Lens' ProjectListProjectsItem (Maybe Word64) Source

The numeric ID of this project.

Streamingbuffer

data Streamingbuffer Source

Instances

streamingbuffer :: Streamingbuffer Source

Creates a value of Streamingbuffer with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sEstimatedBytes :: Lens' Streamingbuffer (Maybe Word64) Source

Output-only
A lower-bound estimate of the number of bytes currently in the streaming buffer.

sOldestEntryTime :: Lens' Streamingbuffer (Maybe Word64) Source

Output-only
Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

sEstimatedRows :: Lens' Streamingbuffer (Maybe Word64) Source

Output-only
A lower-bound estimate of the number of rows currently in the streaming buffer.

TableRow

data TableRow Source

Instances

tableRow :: TableRow Source

Creates a value of TableRow with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

trF :: Lens' TableRow [TableCell] Source

Represents a single row in the result set, consisting of one or more fields.

JobListJobsItem

data JobListJobsItem Source

Instances

jobListJobsItem :: JobListJobsItem Source

Creates a value of JobListJobsItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

jljiJobReference :: Lens' JobListJobsItem (Maybe JobReference) Source

Job reference uniquely identifying the job.

jljiStatus :: Lens' JobListJobsItem (Maybe JobStatus) Source

Full-projection-only
Describes the state of the job.

jljiState :: Lens' JobListJobsItem (Maybe Text) Source

Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed.

jljiUserEmail :: Lens' JobListJobsItem (Maybe Text) Source

Full-projection-only
Email address of the user who ran the job.

jljiKind :: Lens' JobListJobsItem Text Source

The resource type.

jljiErrorResult :: Lens' JobListJobsItem (Maybe ErrorProto) Source

A result object that will be present only if the job has failed.

jljiId :: Lens' JobListJobsItem (Maybe Text) Source

Unique opaque ID of the job.

jljiStatistics :: Lens' JobListJobsItem (Maybe JobStatistics) Source

Output-only
Information about the job, including starting time and ending time of the job.

jljiConfiguration :: Lens' JobListJobsItem (Maybe JobConfiguration) Source

Full-projection-only
Specifies the job configuration.

JobConfiguration

data JobConfiguration Source

Instances

jobConfiguration :: JobConfiguration Source

Creates a value of JobConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

jcCopy :: Lens' JobConfiguration (Maybe JobConfigurationTableCopy) Source

Pick one
Copies a table.

jcLink :: Lens' JobConfiguration (Maybe JobConfigurationLink) Source

Pick one
Configures a link job.

jcLoad :: Lens' JobConfiguration (Maybe JobConfigurationLoad) Source

Pick one
Configures a load job.

jcQuery :: Lens' JobConfiguration (Maybe JobConfigurationQuery) Source

Pick one
Configures a query job.

jcExtract :: Lens' JobConfiguration (Maybe JobConfigurationExtract) Source

Pick one
Configures an extract job.

jcDryRun :: Lens' JobConfiguration (Maybe Bool) Source

Optional
If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.

Job

data Job Source

Instances

job :: Job Source

Creates a value of Job with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

jJobReference :: Lens' Job (Maybe JobReference) Source

Optional
Reference describing the unique-per-user name of the job.

jStatus :: Lens' Job (Maybe JobStatus) Source

Output-only
The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.

jEtag :: Lens' Job (Maybe Text) Source

Output-only
A hash of this resource.

jUserEmail :: Lens' Job (Maybe Text) Source

Output-only
Email address of the user who ran the job.

jKind :: Lens' Job Text Source

Output-only
The type of the resource.

jSelfLink :: Lens' Job (Maybe Text) Source

Output-only
A URL that can be used to access this resource again.

jId :: Lens' Job (Maybe Text) Source

Output-only
Opaque ID field of the job

jStatistics :: Lens' Job (Maybe JobStatistics) Source

Output-only
Information about the job, including starting time and ending time of the job.

jConfiguration :: Lens' Job (Maybe JobConfiguration) Source

Required
Describes the job configuration.

JobConfigurationLink

data JobConfigurationLink Source

jobConfigurationLink :: JobConfigurationLink Source

Creates a value of JobConfigurationLink with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

jDestinationTable :: Lens' JobConfigurationLink (Maybe TableReference) Source

Required
The destination table of the link job.

jWriteDisPosition :: Lens' JobConfigurationLink (Maybe Text) Source

Optional
Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.

jCreateDisPosition :: Lens' JobConfigurationLink (Maybe Text) Source

Optional
Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.

jSourceURI :: Lens' JobConfigurationLink [Text] Source

Required
URI of source table to link.

TableDataInsertAllResponseInsertErrorsItem

data TableDataInsertAllResponseInsertErrorsItem Source

Instances

tableDataInsertAllResponseInsertErrorsItem :: TableDataInsertAllResponseInsertErrorsItem Source

Creates a value of TableDataInsertAllResponseInsertErrorsItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tdiarieiErrors :: Lens' TableDataInsertAllResponseInsertErrorsItem [ErrorProto] Source

Error information for the row indicated by the index property.

tdiarieiIndex :: Lens' TableDataInsertAllResponseInsertErrorsItem (Maybe Word32) Source

The index of the row that error applies to.

JobConfigurationExtract

data JobConfigurationExtract Source

Instances

jobConfigurationExtract :: JobConfigurationExtract Source

Creates a value of JobConfigurationExtract with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

jceDestinationFormat :: Lens' JobConfigurationExtract (Maybe Text) Source

Optional
The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV.

jceSourceTable :: Lens' JobConfigurationExtract (Maybe TableReference) Source

Required
A reference to the table being exported.

jcePrintHeader :: Lens' JobConfigurationExtract Bool Source

Optional
Whether to print out a header row in the results. Default is true.

jceCompression :: Lens' JobConfigurationExtract (Maybe Text) Source

Optional
The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE.

jceDestinationURIs :: Lens' JobConfigurationExtract [Text] Source

Pick one
A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.

jceDestinationURI :: Lens' JobConfigurationExtract (Maybe Text) Source

Pick one
DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.

jceFieldDelimiter :: Lens' JobConfigurationExtract (Maybe Text) Source

Optional
Delimiter to use between fields in the exported data. Default is ','

JobCancelResponse

data JobCancelResponse Source

Instances

jobCancelResponse :: JobCancelResponse Source

Creates a value of JobCancelResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

jcrKind :: Lens' JobCancelResponse Text Source

The resource type of the response.

jcrJob :: Lens' JobCancelResponse (Maybe Job) Source

The final state of the job.

JSONObject

data JSONObject Source

Represents a single JSON object.

See: jsonObject smart constructor.

Instances

jsonObject Source

Arguments

:: HashMap Text JSONValue

joAddtional

-> JSONObject 

Creates a value of JSONObject with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

joAddtional :: Lens' JSONObject (HashMap Text JSONValue) Source

JobConfigurationQuery

data JobConfigurationQuery Source

Instances

jobConfigurationQuery :: JobConfigurationQuery Source

Creates a value of JobConfigurationQuery with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

jcqDestinationTable :: Lens' JobConfigurationQuery (Maybe TableReference) Source

Optional
Describes the table where the query results should be stored. If not present, a new table will be created to store the results.

jcqWriteDisPosition :: Lens' JobConfigurationQuery (Maybe Text) Source

Optional
Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.

jcqPriority :: Lens' JobConfigurationQuery (Maybe Text) Source

Optional
Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.

jcqUseQueryCache :: Lens' JobConfigurationQuery Bool Source

Optional
Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.

jcqPreserveNulls :: Lens' JobConfigurationQuery (Maybe Bool) Source

Deprecated
This property is deprecated.

jcqTableDefinitions :: Lens' JobConfigurationQuery (Maybe JobConfigurationQueryTableDefinitions) Source

Experimental
If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

jcqCreateDisPosition :: Lens' JobConfigurationQuery (Maybe Text) Source

Optional
Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.

jcqUserDefinedFunctionResources :: Lens' JobConfigurationQuery [UserDefinedFunctionResource] Source

Experimental
Describes user-defined function resources used in the query.

jcqAllowLargeResults :: Lens' JobConfigurationQuery (Maybe Bool) Source

If true, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set.

jcqQuery :: Lens' JobConfigurationQuery (Maybe Text) Source

Required
BigQuery SQL query to execute.

jcqFlattenResults :: Lens' JobConfigurationQuery Bool Source

Optional
Flattens all nested and repeated fields in the query results. The default value is true. allowLargeResults must be true if this is set to false.

jcqDefaultDataSet :: Lens' JobConfigurationQuery (Maybe DataSetReference) Source

Optional
Specifies the default dataset to use for unqualified table names in the query.

TableDataInsertAllRequestRowsItem

data TableDataInsertAllRequestRowsItem Source

Instances

tableDataInsertAllRequestRowsItem :: TableDataInsertAllRequestRowsItem Source

Creates a value of TableDataInsertAllRequestRowsItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tdiarriJSON :: Lens' TableDataInsertAllRequestRowsItem (Maybe JSONObject) Source

Required
A JSON object that contains a row of data. The object's properties and values must match the destination table's schema.

tdiarriInsertId :: Lens' TableDataInsertAllRequestRowsItem (Maybe Text) Source

Optional
A unique ID for each row. BigQuery uses this property to detect duplicate insertion requests on a best-effort basis.

JobList

data JobList Source

Instances

jobList :: JobList Source

Creates a value of JobList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

jlEtag :: Lens' JobList (Maybe Text) Source

A hash of this page of results.

jlNextPageToken :: Lens' JobList (Maybe Text) Source

A token to request the next page of results.

jlKind :: Lens' JobList Text Source

The resource type of the response.

jlJobs :: Lens' JobList [JobListJobsItem] Source

List of jobs that were requested.

JobConfigurationQueryTableDefinitions

data JobConfigurationQueryTableDefinitions Source

Experimental
If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

See: jobConfigurationQueryTableDefinitions smart constructor.

Instances

jobConfigurationQueryTableDefinitions Source

Arguments

:: HashMap Text ExternalDataConfiguration

jcqtdAddtional

-> JobConfigurationQueryTableDefinitions 

Creates a value of JobConfigurationQueryTableDefinitions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

jcqtdAddtional :: Lens' JobConfigurationQueryTableDefinitions (HashMap Text ExternalDataConfiguration) Source

TableCell

data TableCell Source

Instances

tableCell :: TableCell Source

Creates a value of TableCell with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tcV :: Lens' TableCell (Maybe JSONValue) Source

ViewDefinition

data ViewDefinition Source

Instances

viewDefinition :: ViewDefinition Source

Creates a value of ViewDefinition with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

vdQuery :: Lens' ViewDefinition (Maybe Text) Source

Required
A query that BigQuery executes when the view is referenced.

UserDefinedFunctionResource

data UserDefinedFunctionResource Source

Instances

userDefinedFunctionResource :: UserDefinedFunctionResource Source

Creates a value of UserDefinedFunctionResource with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

udfrResourceURI :: Lens' UserDefinedFunctionResource (Maybe Text) Source

Pick one
A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

udfrInlineCode :: Lens' UserDefinedFunctionResource (Maybe Text) Source

Pick one
An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.

JobStatistics2

data JobStatistics2 Source

Instances

jobStatistics2 :: JobStatistics2 Source

Creates a value of JobStatistics2 with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

jTotalBytesProcessed :: Lens' JobStatistics2 (Maybe Int64) Source

Output-only
Total bytes processed for the job.

jBillingTier :: Lens' JobStatistics2 (Maybe Int32) Source

Output-only
Billing tier for the job.

jCacheHit :: Lens' JobStatistics2 (Maybe Bool) Source

Output-only
Whether the query result was fetched from the query cache.

jTotalBytesBilled :: Lens' JobStatistics2 (Maybe Int64) Source

Output-only
Total bytes billed for the job.

JobStatus

data JobStatus Source

Instances

jobStatus :: JobStatus Source

Creates a value of JobStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

jsState :: Lens' JobStatus (Maybe Text) Source

Output-only
Running state of the job.

jsErrorResult :: Lens' JobStatus (Maybe ErrorProto) Source

Output-only
Final error result of the job. If present, indicates that the job has completed and was unsuccessful.

jsErrors :: Lens' JobStatus [ErrorProto] Source

Output-only
All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.

DataSetAccessItem

data DataSetAccessItem Source

Instances

dataSetAccessItem :: DataSetAccessItem Source

Creates a value of DataSetAccessItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dsaiGroupByEmail :: Lens' DataSetAccessItem (Maybe Text) Source

Pick one
An email address of a Google Group to grant access to.

dsaiDomain :: Lens' DataSetAccessItem (Maybe Text) Source

Pick one
A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".

dsaiSpecialGroup :: Lens' DataSetAccessItem (Maybe Text) Source

Pick one
A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.

dsaiRole :: Lens' DataSetAccessItem (Maybe Text) Source

Required
Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READER, WRITER, OWNER.

dsaiView :: Lens' DataSetAccessItem (Maybe TableReference) Source

Pick one
A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.

dsaiUserByEmail :: Lens' DataSetAccessItem (Maybe Text) Source

Pick one
An email address of a user to grant access to. For example: fred'example.com.

TableDataInsertAllResponse

data TableDataInsertAllResponse Source

Instances

tableDataInsertAllResponse :: TableDataInsertAllResponse Source

Creates a value of TableDataInsertAllResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tKind :: Lens' TableDataInsertAllResponse Text Source

The resource type of the response.

tInsertErrors :: Lens' TableDataInsertAllResponse [TableDataInsertAllResponseInsertErrorsItem] Source

An array of errors for rows that were not inserted.

Table

data Table Source

Instances

table :: Table Source

Creates a value of Table with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tabCreationTime :: Lens' Table (Maybe Int64) Source

Output-only
The time when this table was created, in milliseconds since the epoch.

tabEtag :: Lens' Table (Maybe Text) Source

Output-only
A hash of this resource.

tabNumBytes :: Lens' Table (Maybe Int64) Source

Output-only
The size of this table in bytes, excluding any data in the streaming buffer.

tabExternalDataConfiguration :: Lens' Table (Maybe ExternalDataConfiguration) Source

Experimental
Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

tabLocation :: Lens' Table (Maybe Text) Source

Output-only
The geographic location where the table resides. This value is inherited from the dataset.

tabTableReference :: Lens' Table (Maybe TableReference) Source

Required
Reference describing the ID of this table.

tabFriendlyName :: Lens' Table (Maybe Text) Source

Optional
A descriptive name for this table.

tabKind :: Lens' Table Text Source

Output-only
The type of the resource.

tabLastModifiedTime :: Lens' Table (Maybe Word64) Source

Output-only
The time when this table was last modified, in milliseconds since the epoch.

tabSchema :: Lens' Table (Maybe TableSchema) Source

Optional
Describes the schema of this table.

tabStreamingBuffer :: Lens' Table (Maybe Streamingbuffer) Source

Output-only
Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

tabSelfLink :: Lens' Table (Maybe Text) Source

Output-only
A URL that can be used to access this resource again.

tabNumRows :: Lens' Table (Maybe Word64) Source

Output-only
The number of rows of data in this table, excluding any data in the streaming buffer.

tabView :: Lens' Table (Maybe ViewDefinition) Source

Optional
The view definition.

tabId :: Lens' Table (Maybe Text) Source

Output-only
An opaque ID uniquely identifying the table.

tabType :: Lens' Table (Maybe Text) Source

Output-only
Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. The default value is TABLE.

tabExpirationTime :: Lens' Table (Maybe Int64) Source

Optional
The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.

tabDescription :: Lens' Table (Maybe Text) Source

Optional
A user-friendly description of this table.

ErrorProto

data ErrorProto Source

Instances

errorProto :: ErrorProto Source

Creates a value of ErrorProto with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

epDebugInfo :: Lens' ErrorProto (Maybe Text) Source

Debugging information. This property is internal to Google and should not be used.

epLocation :: Lens' ErrorProto (Maybe Text) Source

Specifies where the error occurred, if present.

epReason :: Lens' ErrorProto (Maybe Text) Source

A short error code that summarizes the error.

epMessage :: Lens' ErrorProto (Maybe Text) Source

A human-readable description of the error.

CSVOptions

data CSVOptions Source

Instances

csvOptions :: CSVOptions Source

Creates a value of CSVOptions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

coSkipLeadingRows :: Lens' CSVOptions (Maybe Int32) Source

Optional
The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.

coAllowJaggedRows :: Lens' CSVOptions (Maybe Bool) Source

Optional
Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.

coAllowQuotedNewlines :: Lens' CSVOptions (Maybe Bool) Source

Optional
Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

coQuote :: Lens' CSVOptions Text Source

Optional
The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

coEncoding :: Lens' CSVOptions (Maybe Text) Source

Optional
The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

coFieldDelimiter :: Lens' CSVOptions (Maybe Text) Source

Optional
The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').

JobStatistics3

data JobStatistics3 Source

Instances

jobStatistics3 :: JobStatistics3 Source

Creates a value of JobStatistics3 with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

jsInputFiles :: Lens' JobStatistics3 (Maybe Int64) Source

Output-only
Number of source files in a load job.

jsOutputRows :: Lens' JobStatistics3 (Maybe Int64) Source

Output-only
Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.

jsOutputBytes :: Lens' JobStatistics3 (Maybe Int64) Source

Output-only
Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.

jsInputFileBytes :: Lens' JobStatistics3 (Maybe Int64) Source

Output-only
Number of bytes of source data in a load job.

QueryResponse

data QueryResponse Source

Instances

queryResponse :: QueryResponse Source

Creates a value of QueryResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

qJobReference :: Lens' QueryResponse (Maybe JobReference) Source

Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).

qKind :: Lens' QueryResponse Text Source

The resource type.

qSchema :: Lens' QueryResponse (Maybe TableSchema) Source

The schema of the results. Present only when the query completes successfully.

qTotalBytesProcessed :: Lens' QueryResponse (Maybe Int64) Source

The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run.

qRows :: Lens' QueryResponse [TableRow] Source

An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above.

qPageToken :: Lens' QueryResponse (Maybe Text) Source

A token used for paging results.

qTotalRows :: Lens' QueryResponse (Maybe Word64) Source

The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results.

qErrors :: Lens' QueryResponse [ErrorProto] Source

Output-only
All errors and warnings encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.

qJobComplete :: Lens' QueryResponse (Maybe Bool) Source

Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.

qCacheHit :: Lens' QueryResponse (Maybe Bool) Source

Whether the query result was fetched from the query cache.