Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- bigquery.datasets.delete
- bigquery.datasets.get
- bigquery.datasets.insert
- bigquery.datasets.list
- bigquery.datasets.patch
- bigquery.datasets.update
- bigquery.jobs.cancel
- bigquery.jobs.get
- bigquery.jobs.getQueryResults
- bigquery.jobs.insert
- bigquery.jobs.list
- bigquery.jobs.query
- bigquery.projects.list
- bigquery.tabledata.insertAll
- bigquery.tabledata.list
- bigquery.tables.delete
- bigquery.tables.get
- bigquery.tables.insert
- bigquery.tables.list
- bigquery.tables.patch
- bigquery.tables.update
- Types
- JobReference
- TableList
- DataSetListDataSetsItem
- TableDataList
- JobConfigurationTableCopy
- TableListTablesItem
- TableSchema
- ProjectList
- ExplainQueryStep
- BigtableColumnFamily
- JobStatistics
- DataSet
- BigtableOptions
- ExternalDataConfiguration
- TableReference
- TableFieldSchema
- GetQueryResultsResponse
- DataSetList
- QueryRequest
- JobsListProjection
- JobStatistics4
- ProjectReference
- ExplainQueryStage
- JobConfigurationLoad
- JobsListStateFilter
- DataSetReference
- TableDataInsertAllRequest
- ProjectListProjectsItem
- BigtableColumn
- Streamingbuffer
- TableRow
- JobListJobsItem
- TimePartitioning
- JobConfiguration
- Job
- TableDataInsertAllResponseInsertErrorsItem
- JobConfigurationExtract
- JobCancelResponse
- JSONObject
- JobConfigurationQuery
- GoogleSheetsOptions
- TableDataInsertAllRequestRowsItem
- JobList
- JobConfigurationQueryTableDefinitions
- TableCell
- ViewDefinition
- UserDefinedFunctionResource
- JobStatistics2
- JobStatus
- DataSetAccessItem
- TableDataInsertAllResponse
- Table
- ErrorProto
- CSVOptions
- JobStatistics3
- QueryResponse
A data platform for customers to create, manage, share and query data.
- bigQueryService :: ServiceConfig
- cloudPlatformReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform.read-only"]
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- storageReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/devstorage.read_only"]
- bigQueryInsertDataScope :: Proxy '["https://www.googleapis.com/auth/bigquery.insertdata"]
- storageReadWriteScope :: Proxy '["https://www.googleapis.com/auth/devstorage.read_write"]
- bigQueryScope :: Proxy '["https://www.googleapis.com/auth/bigquery"]
- storageFullControlScope :: Proxy '["https://www.googleapis.com/auth/devstorage.full_control"]
- type BigQueryAPI = JobsInsertResource :<|> (JobsListResource :<|> (JobsGetResource :<|> (JobsQueryResource :<|> (JobsCancelResource :<|> (JobsGetQueryResultsResource :<|> (TablesInsertResource :<|> (TablesListResource :<|> (TablesPatchResource :<|> (TablesGetResource :<|> (TablesDeleteResource :<|> (TablesUpdateResource :<|> (TableDataListResource :<|> (TableDataInsertAllResource :<|> (ProjectsListResource :<|> (DataSetsInsertResource :<|> (DataSetsListResource :<|> (DataSetsPatchResource :<|> (DataSetsGetResource :<|> (DataSetsDeleteResource :<|> DataSetsUpdateResource)))))))))))))))))))
- module Network.Google.Resource.BigQuery.DataSets.Delete
- module Network.Google.Resource.BigQuery.DataSets.Get
- module Network.Google.Resource.BigQuery.DataSets.Insert
- module Network.Google.Resource.BigQuery.DataSets.List
- module Network.Google.Resource.BigQuery.DataSets.Patch
- module Network.Google.Resource.BigQuery.DataSets.Update
- module Network.Google.Resource.BigQuery.Jobs.Cancel
- module Network.Google.Resource.BigQuery.Jobs.Get
- module Network.Google.Resource.BigQuery.Jobs.GetQueryResults
- module Network.Google.Resource.BigQuery.Jobs.Insert
- module Network.Google.Resource.BigQuery.Jobs.List
- module Network.Google.Resource.BigQuery.Jobs.Query
- module Network.Google.Resource.BigQuery.Projects.List
- module Network.Google.Resource.BigQuery.TableData.InsertAll
- module Network.Google.Resource.BigQuery.TableData.List
- module Network.Google.Resource.BigQuery.Tables.Delete
- module Network.Google.Resource.BigQuery.Tables.Get
- module Network.Google.Resource.BigQuery.Tables.Insert
- module Network.Google.Resource.BigQuery.Tables.List
- module Network.Google.Resource.BigQuery.Tables.Patch
- module Network.Google.Resource.BigQuery.Tables.Update
- data JobReference
- jobReference :: JobReference
- jrJobId :: Lens' JobReference (Maybe Text)
- jrProjectId :: Lens' JobReference (Maybe Text)
- data TableList
- tableList :: TableList
- tlTotalItems :: Lens' TableList (Maybe Int32)
- tlEtag :: Lens' TableList (Maybe Text)
- tlNextPageToken :: Lens' TableList (Maybe Text)
- tlKind :: Lens' TableList Text
- tlTables :: Lens' TableList [TableListTablesItem]
- data DataSetListDataSetsItem
- dataSetListDataSetsItem :: DataSetListDataSetsItem
- dsldsiFriendlyName :: Lens' DataSetListDataSetsItem (Maybe Text)
- dsldsiKind :: Lens' DataSetListDataSetsItem Text
- dsldsiDataSetReference :: Lens' DataSetListDataSetsItem (Maybe DataSetReference)
- dsldsiId :: Lens' DataSetListDataSetsItem (Maybe Text)
- data TableDataList
- tableDataList :: TableDataList
- tdlEtag :: Lens' TableDataList (Maybe Text)
- tdlKind :: Lens' TableDataList Text
- tdlRows :: Lens' TableDataList [TableRow]
- tdlPageToken :: Lens' TableDataList (Maybe Text)
- tdlTotalRows :: Lens' TableDataList (Maybe Int64)
- data JobConfigurationTableCopy
- jobConfigurationTableCopy :: JobConfigurationTableCopy
- jctcDestinationTable :: Lens' JobConfigurationTableCopy (Maybe TableReference)
- jctcWriteDisPosition :: Lens' JobConfigurationTableCopy (Maybe Text)
- jctcSourceTables :: Lens' JobConfigurationTableCopy [TableReference]
- jctcCreateDisPosition :: Lens' JobConfigurationTableCopy (Maybe Text)
- jctcSourceTable :: Lens' JobConfigurationTableCopy (Maybe TableReference)
- data TableListTablesItem
- tableListTablesItem :: TableListTablesItem
- tltiTableReference :: Lens' TableListTablesItem (Maybe TableReference)
- tltiFriendlyName :: Lens' TableListTablesItem (Maybe Text)
- tltiKind :: Lens' TableListTablesItem Text
- tltiId :: Lens' TableListTablesItem (Maybe Text)
- tltiType :: Lens' TableListTablesItem (Maybe Text)
- data TableSchema
- tableSchema :: TableSchema
- tsFields :: Lens' TableSchema [TableFieldSchema]
- data ProjectList
- projectList :: ProjectList
- plTotalItems :: Lens' ProjectList (Maybe Int32)
- plEtag :: Lens' ProjectList (Maybe Text)
- plNextPageToken :: Lens' ProjectList (Maybe Text)
- plKind :: Lens' ProjectList Text
- plProjects :: Lens' ProjectList [ProjectListProjectsItem]
- data ExplainQueryStep
- explainQueryStep :: ExplainQueryStep
- eqsSubsteps :: Lens' ExplainQueryStep [Text]
- eqsKind :: Lens' ExplainQueryStep (Maybe Text)
- data BigtableColumnFamily
- bigtableColumnFamily :: BigtableColumnFamily
- bcfFamilyId :: Lens' BigtableColumnFamily (Maybe Text)
- bcfColumns :: Lens' BigtableColumnFamily [BigtableColumn]
- bcfOnlyReadLatest :: Lens' BigtableColumnFamily (Maybe Bool)
- bcfType :: Lens' BigtableColumnFamily (Maybe Text)
- bcfEncoding :: Lens' BigtableColumnFamily (Maybe Text)
- data JobStatistics
- jobStatistics :: JobStatistics
- jsCreationTime :: Lens' JobStatistics (Maybe Int64)
- jsStartTime :: Lens' JobStatistics (Maybe Int64)
- jsLoad :: Lens' JobStatistics (Maybe JobStatistics3)
- jsTotalBytesProcessed :: Lens' JobStatistics (Maybe Int64)
- jsEndTime :: Lens' JobStatistics (Maybe Int64)
- jsQuery :: Lens' JobStatistics (Maybe JobStatistics2)
- jsExtract :: Lens' JobStatistics (Maybe JobStatistics4)
- data DataSet
- dataSet :: DataSet
- dsCreationTime :: Lens' DataSet (Maybe Int64)
- dsAccess :: Lens' DataSet [DataSetAccessItem]
- dsEtag :: Lens' DataSet (Maybe Text)
- dsLocation :: Lens' DataSet (Maybe Text)
- dsFriendlyName :: Lens' DataSet (Maybe Text)
- dsKind :: Lens' DataSet Text
- dsLastModifiedTime :: Lens' DataSet (Maybe Int64)
- dsDataSetReference :: Lens' DataSet (Maybe DataSetReference)
- dsSelfLink :: Lens' DataSet (Maybe Text)
- dsId :: Lens' DataSet (Maybe Text)
- dsDefaultTableExpirationMs :: Lens' DataSet (Maybe Int64)
- dsDescription :: Lens' DataSet (Maybe Text)
- data BigtableOptions
- bigtableOptions :: BigtableOptions
- boIgnoreUnspecifiedColumnFamilies :: Lens' BigtableOptions (Maybe Bool)
- boColumnFamilies :: Lens' BigtableOptions [BigtableColumnFamily]
- data ExternalDataConfiguration
- externalDataConfiguration :: ExternalDataConfiguration
- edcBigtableOptions :: Lens' ExternalDataConfiguration (Maybe BigtableOptions)
- edcIgnoreUnknownValues :: Lens' ExternalDataConfiguration (Maybe Bool)
- edcCompression :: Lens' ExternalDataConfiguration (Maybe Text)
- edcSourceFormat :: Lens' ExternalDataConfiguration (Maybe Text)
- edcSchema :: Lens' ExternalDataConfiguration (Maybe TableSchema)
- edcMaxBadRecords :: Lens' ExternalDataConfiguration (Maybe Int32)
- edcGoogleSheetsOptions :: Lens' ExternalDataConfiguration (Maybe GoogleSheetsOptions)
- edcAutodetect :: Lens' ExternalDataConfiguration (Maybe Bool)
- edcSourceURIs :: Lens' ExternalDataConfiguration [Text]
- edcCSVOptions :: Lens' ExternalDataConfiguration (Maybe CSVOptions)
- data TableReference
- tableReference :: TableReference
- trDataSetId :: Lens' TableReference (Maybe Text)
- trProjectId :: Lens' TableReference (Maybe Text)
- trTableId :: Lens' TableReference (Maybe Text)
- data TableFieldSchema
- tableFieldSchema :: TableFieldSchema
- tfsMode :: Lens' TableFieldSchema (Maybe Text)
- tfsName :: Lens' TableFieldSchema (Maybe Text)
- tfsType :: Lens' TableFieldSchema (Maybe Text)
- tfsDescription :: Lens' TableFieldSchema (Maybe Text)
- tfsFields :: Lens' TableFieldSchema [TableFieldSchema]
- data GetQueryResultsResponse
- getQueryResultsResponse :: GetQueryResultsResponse
- gqrrJobReference :: Lens' GetQueryResultsResponse (Maybe JobReference)
- gqrrEtag :: Lens' GetQueryResultsResponse (Maybe Text)
- gqrrKind :: Lens' GetQueryResultsResponse Text
- gqrrSchema :: Lens' GetQueryResultsResponse (Maybe TableSchema)
- gqrrTotalBytesProcessed :: Lens' GetQueryResultsResponse (Maybe Int64)
- gqrrRows :: Lens' GetQueryResultsResponse [TableRow]
- gqrrPageToken :: Lens' GetQueryResultsResponse (Maybe Text)
- gqrrTotalRows :: Lens' GetQueryResultsResponse (Maybe Word64)
- gqrrErrors :: Lens' GetQueryResultsResponse [ErrorProto]
- gqrrJobComplete :: Lens' GetQueryResultsResponse (Maybe Bool)
- gqrrCacheHit :: Lens' GetQueryResultsResponse (Maybe Bool)
- data DataSetList
- dataSetList :: DataSetList
- dslEtag :: Lens' DataSetList (Maybe Text)
- dslNextPageToken :: Lens' DataSetList (Maybe Text)
- dslKind :: Lens' DataSetList Text
- dslDataSets :: Lens' DataSetList [DataSetListDataSetsItem]
- data QueryRequest
- queryRequest :: QueryRequest
- qrUseQueryCache :: Lens' QueryRequest Bool
- qrPreserveNulls :: Lens' QueryRequest (Maybe Bool)
- qrKind :: Lens' QueryRequest Text
- qrQuery :: Lens' QueryRequest (Maybe Text)
- qrTimeoutMs :: Lens' QueryRequest (Maybe Word32)
- qrUseLegacySQL :: Lens' QueryRequest (Maybe Bool)
- qrDryRun :: Lens' QueryRequest (Maybe Bool)
- qrMaxResults :: Lens' QueryRequest (Maybe Word32)
- qrDefaultDataSet :: Lens' QueryRequest (Maybe DataSetReference)
- data JobsListProjection
- data JobStatistics4
- jobStatistics4 :: JobStatistics4
- jsDestinationURIFileCounts :: Lens' JobStatistics4 [Int64]
- data ProjectReference
- projectReference :: ProjectReference
- prProjectId :: Lens' ProjectReference (Maybe Text)
- data ExplainQueryStage
- explainQueryStage :: ExplainQueryStage
- eqsWaitRatioMax :: Lens' ExplainQueryStage (Maybe Double)
- eqsRecordsWritten :: Lens' ExplainQueryStage (Maybe Int64)
- eqsSteps :: Lens' ExplainQueryStage [ExplainQueryStep]
- eqsWriteRatioAvg :: Lens' ExplainQueryStage (Maybe Double)
- eqsRecordsRead :: Lens' ExplainQueryStage (Maybe Int64)
- eqsComputeRatioAvg :: Lens' ExplainQueryStage (Maybe Double)
- eqsName :: Lens' ExplainQueryStage (Maybe Text)
- eqsReadRatioMax :: Lens' ExplainQueryStage (Maybe Double)
- eqsWaitRatioAvg :: Lens' ExplainQueryStage (Maybe Double)
- eqsId :: Lens' ExplainQueryStage (Maybe Int64)
- eqsComputeRatioMax :: Lens' ExplainQueryStage (Maybe Double)
- eqsWriteRatioMax :: Lens' ExplainQueryStage (Maybe Double)
- eqsReadRatioAvg :: Lens' ExplainQueryStage (Maybe Double)
- data JobConfigurationLoad
- jobConfigurationLoad :: JobConfigurationLoad
- jclSkipLeadingRows :: Lens' JobConfigurationLoad (Maybe Int32)
- jclProjectionFields :: Lens' JobConfigurationLoad [Text]
- jclDestinationTable :: Lens' JobConfigurationLoad (Maybe TableReference)
- jclWriteDisPosition :: Lens' JobConfigurationLoad (Maybe Text)
- jclAllowJaggedRows :: Lens' JobConfigurationLoad (Maybe Bool)
- jclSchemaInline :: Lens' JobConfigurationLoad (Maybe Text)
- jclIgnoreUnknownValues :: Lens' JobConfigurationLoad (Maybe Bool)
- jclCreateDisPosition :: Lens' JobConfigurationLoad (Maybe Text)
- jclSchemaInlineFormat :: Lens' JobConfigurationLoad (Maybe Text)
- jclAllowQuotedNewlines :: Lens' JobConfigurationLoad (Maybe Bool)
- jclSourceFormat :: Lens' JobConfigurationLoad (Maybe Text)
- jclSchema :: Lens' JobConfigurationLoad (Maybe TableSchema)
- jclQuote :: Lens' JobConfigurationLoad Text
- jclMaxBadRecords :: Lens' JobConfigurationLoad (Maybe Int32)
- jclAutodetect :: Lens' JobConfigurationLoad (Maybe Bool)
- jclSourceURIs :: Lens' JobConfigurationLoad [Text]
- jclEncoding :: Lens' JobConfigurationLoad (Maybe Text)
- jclFieldDelimiter :: Lens' JobConfigurationLoad (Maybe Text)
- data JobsListStateFilter
- data DataSetReference
- dataSetReference :: DataSetReference
- dsrDataSetId :: Lens' DataSetReference (Maybe Text)
- dsrProjectId :: Lens' DataSetReference (Maybe Text)
- data TableDataInsertAllRequest
- tableDataInsertAllRequest :: TableDataInsertAllRequest
- tdiarKind :: Lens' TableDataInsertAllRequest Text
- tdiarIgnoreUnknownValues :: Lens' TableDataInsertAllRequest (Maybe Bool)
- tdiarRows :: Lens' TableDataInsertAllRequest [TableDataInsertAllRequestRowsItem]
- tdiarTemplateSuffix :: Lens' TableDataInsertAllRequest (Maybe Text)
- tdiarSkipInvalidRows :: Lens' TableDataInsertAllRequest (Maybe Bool)
- data ProjectListProjectsItem
- projectListProjectsItem :: ProjectListProjectsItem
- plpiFriendlyName :: Lens' ProjectListProjectsItem (Maybe Text)
- plpiKind :: Lens' ProjectListProjectsItem Text
- plpiProjectReference :: Lens' ProjectListProjectsItem (Maybe ProjectReference)
- plpiId :: Lens' ProjectListProjectsItem (Maybe Text)
- plpiNumericId :: Lens' ProjectListProjectsItem (Maybe Word64)
- data BigtableColumn
- bigtableColumn :: BigtableColumn
- bcQualifierEncoded :: Lens' BigtableColumn (Maybe ByteString)
- bcFieldName :: Lens' BigtableColumn (Maybe Text)
- bcQualifierString :: Lens' BigtableColumn (Maybe Text)
- bcOnlyReadLatest :: Lens' BigtableColumn (Maybe Bool)
- bcType :: Lens' BigtableColumn (Maybe Text)
- bcEncoding :: Lens' BigtableColumn (Maybe Text)
- data Streamingbuffer
- streamingbuffer :: Streamingbuffer
- sEstimatedBytes :: Lens' Streamingbuffer (Maybe Word64)
- sOldestEntryTime :: Lens' Streamingbuffer (Maybe Word64)
- sEstimatedRows :: Lens' Streamingbuffer (Maybe Word64)
- data TableRow
- tableRow :: TableRow
- trF :: Lens' TableRow [TableCell]
- data JobListJobsItem
- jobListJobsItem :: JobListJobsItem
- jljiJobReference :: Lens' JobListJobsItem (Maybe JobReference)
- jljiStatus :: Lens' JobListJobsItem (Maybe JobStatus)
- jljiState :: Lens' JobListJobsItem (Maybe Text)
- jljiUserEmail :: Lens' JobListJobsItem (Maybe Text)
- jljiKind :: Lens' JobListJobsItem Text
- jljiErrorResult :: Lens' JobListJobsItem (Maybe ErrorProto)
- jljiId :: Lens' JobListJobsItem (Maybe Text)
- jljiStatistics :: Lens' JobListJobsItem (Maybe JobStatistics)
- jljiConfiguration :: Lens' JobListJobsItem (Maybe JobConfiguration)
- data TimePartitioning
- timePartitioning :: TimePartitioning
- tpExpirationMs :: Lens' TimePartitioning (Maybe Int64)
- tpType :: Lens' TimePartitioning (Maybe Text)
- data JobConfiguration
- jobConfiguration :: JobConfiguration
- jcCopy :: Lens' JobConfiguration (Maybe JobConfigurationTableCopy)
- jcLoad :: Lens' JobConfiguration (Maybe JobConfigurationLoad)
- jcQuery :: Lens' JobConfiguration (Maybe JobConfigurationQuery)
- jcExtract :: Lens' JobConfiguration (Maybe JobConfigurationExtract)
- jcDryRun :: Lens' JobConfiguration (Maybe Bool)
- data Job
- job :: Job
- jJobReference :: Lens' Job (Maybe JobReference)
- jStatus :: Lens' Job (Maybe JobStatus)
- jEtag :: Lens' Job (Maybe Text)
- jUserEmail :: Lens' Job (Maybe Text)
- jKind :: Lens' Job Text
- jSelfLink :: Lens' Job (Maybe Text)
- jId :: Lens' Job (Maybe Text)
- jStatistics :: Lens' Job (Maybe JobStatistics)
- jConfiguration :: Lens' Job (Maybe JobConfiguration)
- data TableDataInsertAllResponseInsertErrorsItem
- tableDataInsertAllResponseInsertErrorsItem :: TableDataInsertAllResponseInsertErrorsItem
- tdiarieiErrors :: Lens' TableDataInsertAllResponseInsertErrorsItem [ErrorProto]
- tdiarieiIndex :: Lens' TableDataInsertAllResponseInsertErrorsItem (Maybe Word32)
- data JobConfigurationExtract
- jobConfigurationExtract :: JobConfigurationExtract
- jceDestinationFormat :: Lens' JobConfigurationExtract (Maybe Text)
- jceSourceTable :: Lens' JobConfigurationExtract (Maybe TableReference)
- jcePrintHeader :: Lens' JobConfigurationExtract Bool
- jceCompression :: Lens' JobConfigurationExtract (Maybe Text)
- jceDestinationURIs :: Lens' JobConfigurationExtract [Text]
- jceDestinationURI :: Lens' JobConfigurationExtract (Maybe Text)
- jceFieldDelimiter :: Lens' JobConfigurationExtract (Maybe Text)
- data JobCancelResponse
- jobCancelResponse :: JobCancelResponse
- jcrKind :: Lens' JobCancelResponse Text
- jcrJob :: Lens' JobCancelResponse (Maybe Job)
- data JSONObject
- jsonObject :: HashMap Text JSONValue -> JSONObject
- joAddtional :: Lens' JSONObject (HashMap Text JSONValue)
- data JobConfigurationQuery
- jobConfigurationQuery :: JobConfigurationQuery
- jcqDestinationTable :: Lens' JobConfigurationQuery (Maybe TableReference)
- jcqWriteDisPosition :: Lens' JobConfigurationQuery (Maybe Text)
- jcqPriority :: Lens' JobConfigurationQuery (Maybe Text)
- jcqUseQueryCache :: Lens' JobConfigurationQuery Bool
- jcqPreserveNulls :: Lens' JobConfigurationQuery (Maybe Bool)
- jcqTableDefinitions :: Lens' JobConfigurationQuery (Maybe JobConfigurationQueryTableDefinitions)
- jcqCreateDisPosition :: Lens' JobConfigurationQuery (Maybe Text)
- jcqUserDefinedFunctionResources :: Lens' JobConfigurationQuery [UserDefinedFunctionResource]
- jcqAllowLargeResults :: Lens' JobConfigurationQuery (Maybe Bool)
- jcqMaximumBillingTier :: Lens' JobConfigurationQuery Int32
- jcqQuery :: Lens' JobConfigurationQuery (Maybe Text)
- jcqFlattenResults :: Lens' JobConfigurationQuery Bool
- jcqUseLegacySQL :: Lens' JobConfigurationQuery (Maybe Bool)
- jcqDefaultDataSet :: Lens' JobConfigurationQuery (Maybe DataSetReference)
- data GoogleSheetsOptions
- googleSheetsOptions :: GoogleSheetsOptions
- gsoSkipLeadingRows :: Lens' GoogleSheetsOptions (Maybe Int64)
- data TableDataInsertAllRequestRowsItem
- tableDataInsertAllRequestRowsItem :: TableDataInsertAllRequestRowsItem
- tdiarriJSON :: Lens' TableDataInsertAllRequestRowsItem (Maybe JSONObject)
- tdiarriInsertId :: Lens' TableDataInsertAllRequestRowsItem (Maybe Text)
- data JobList
- jobList :: JobList
- jlEtag :: Lens' JobList (Maybe Text)
- jlNextPageToken :: Lens' JobList (Maybe Text)
- jlKind :: Lens' JobList Text
- jlJobs :: Lens' JobList [JobListJobsItem]
- data JobConfigurationQueryTableDefinitions
- jobConfigurationQueryTableDefinitions :: HashMap Text ExternalDataConfiguration -> JobConfigurationQueryTableDefinitions
- jcqtdAddtional :: Lens' JobConfigurationQueryTableDefinitions (HashMap Text ExternalDataConfiguration)
- data TableCell
- tableCell :: TableCell
- tcV :: Lens' TableCell (Maybe JSONValue)
- data ViewDefinition
- viewDefinition :: ViewDefinition
- vdUserDefinedFunctionResources :: Lens' ViewDefinition [UserDefinedFunctionResource]
- vdQuery :: Lens' ViewDefinition (Maybe Text)
- data UserDefinedFunctionResource
- userDefinedFunctionResource :: UserDefinedFunctionResource
- udfrResourceURI :: Lens' UserDefinedFunctionResource (Maybe Text)
- udfrInlineCode :: Lens' UserDefinedFunctionResource (Maybe Text)
- data JobStatistics2
- jobStatistics2 :: JobStatistics2
- jSchema :: Lens' JobStatistics2 (Maybe TableSchema)
- jTotalBytesProcessed :: Lens' JobStatistics2 (Maybe Int64)
- jBillingTier :: Lens' JobStatistics2 (Maybe Int32)
- jReferencedTables :: Lens' JobStatistics2 [TableReference]
- jQueryPlan :: Lens' JobStatistics2 [ExplainQueryStage]
- jCacheHit :: Lens' JobStatistics2 (Maybe Bool)
- jTotalBytesBilled :: Lens' JobStatistics2 (Maybe Int64)
- data JobStatus
- jobStatus :: JobStatus
- jsState :: Lens' JobStatus (Maybe Text)
- jsErrorResult :: Lens' JobStatus (Maybe ErrorProto)
- jsErrors :: Lens' JobStatus [ErrorProto]
- data DataSetAccessItem
- dataSetAccessItem :: DataSetAccessItem
- dsaiGroupByEmail :: Lens' DataSetAccessItem (Maybe Text)
- dsaiDomain :: Lens' DataSetAccessItem (Maybe Text)
- dsaiSpecialGroup :: Lens' DataSetAccessItem (Maybe Text)
- dsaiRole :: Lens' DataSetAccessItem (Maybe Text)
- dsaiView :: Lens' DataSetAccessItem (Maybe TableReference)
- dsaiUserByEmail :: Lens' DataSetAccessItem (Maybe Text)
- data TableDataInsertAllResponse
- tableDataInsertAllResponse :: TableDataInsertAllResponse
- tKind :: Lens' TableDataInsertAllResponse Text
- tInsertErrors :: Lens' TableDataInsertAllResponse [TableDataInsertAllResponseInsertErrorsItem]
- data Table
- table :: Table
- tabCreationTime :: Lens' Table (Maybe Int64)
- tabEtag :: Lens' Table (Maybe Text)
- tabNumBytes :: Lens' Table (Maybe Int64)
- tabExternalDataConfiguration :: Lens' Table (Maybe ExternalDataConfiguration)
- tabLocation :: Lens' Table (Maybe Text)
- tabTableReference :: Lens' Table (Maybe TableReference)
- tabFriendlyName :: Lens' Table (Maybe Text)
- tabKind :: Lens' Table Text
- tabLastModifiedTime :: Lens' Table (Maybe Word64)
- tabSchema :: Lens' Table (Maybe TableSchema)
- tabStreamingBuffer :: Lens' Table (Maybe Streamingbuffer)
- tabSelfLink :: Lens' Table (Maybe Text)
- tabTimePartitioning :: Lens' Table (Maybe TimePartitioning)
- tabNumRows :: Lens' Table (Maybe Word64)
- tabView :: Lens' Table (Maybe ViewDefinition)
- tabId :: Lens' Table (Maybe Text)
- tabType :: Lens' Table (Maybe Text)
- tabNumLongTermBytes :: Lens' Table (Maybe Int64)
- tabExpirationTime :: Lens' Table (Maybe Int64)
- tabDescription :: Lens' Table (Maybe Text)
- data ErrorProto
- errorProto :: ErrorProto
- epDebugInfo :: Lens' ErrorProto (Maybe Text)
- epLocation :: Lens' ErrorProto (Maybe Text)
- epReason :: Lens' ErrorProto (Maybe Text)
- epMessage :: Lens' ErrorProto (Maybe Text)
- data CSVOptions
- csvOptions :: CSVOptions
- coSkipLeadingRows :: Lens' CSVOptions (Maybe Int64)
- coAllowJaggedRows :: Lens' CSVOptions (Maybe Bool)
- coAllowQuotedNewlines :: Lens' CSVOptions (Maybe Bool)
- coQuote :: Lens' CSVOptions Text
- coEncoding :: Lens' CSVOptions (Maybe Text)
- coFieldDelimiter :: Lens' CSVOptions (Maybe Text)
- data JobStatistics3
- jobStatistics3 :: JobStatistics3
- jsInputFiles :: Lens' JobStatistics3 (Maybe Int64)
- jsOutputRows :: Lens' JobStatistics3 (Maybe Int64)
- jsOutputBytes :: Lens' JobStatistics3 (Maybe Int64)
- jsInputFileBytes :: Lens' JobStatistics3 (Maybe Int64)
- data QueryResponse
- queryResponse :: QueryResponse
- qJobReference :: Lens' QueryResponse (Maybe JobReference)
- qKind :: Lens' QueryResponse Text
- qSchema :: Lens' QueryResponse (Maybe TableSchema)
- qTotalBytesProcessed :: Lens' QueryResponse (Maybe Int64)
- qRows :: Lens' QueryResponse [TableRow]
- qPageToken :: Lens' QueryResponse (Maybe Text)
- qTotalRows :: Lens' QueryResponse (Maybe Word64)
- qErrors :: Lens' QueryResponse [ErrorProto]
- qJobComplete :: Lens' QueryResponse (Maybe Bool)
- qCacheHit :: Lens' QueryResponse (Maybe Bool)
Service Configuration
bigQueryService :: ServiceConfig 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 :: Proxy '["https://www.googleapis.com/auth/cloud-platform.read-only"] Source #
View your data across Google Cloud Platform services
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] Source #
View and manage your data across Google Cloud Platform services
storageReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/devstorage.read_only"] Source #
View your data in Google Cloud Storage
bigQueryInsertDataScope :: Proxy '["https://www.googleapis.com/auth/bigquery.insertdata"] Source #
Insert data into Google BigQuery
storageReadWriteScope :: Proxy '["https://www.googleapis.com/auth/devstorage.read_write"] Source #
Manage your data in Google Cloud Storage
bigQueryScope :: Proxy '["https://www.googleapis.com/auth/bigquery"] Source #
View and manage your data in Google BigQuery
storageFullControlScope :: Proxy '["https://www.googleapis.com/auth/devstorage.full_control"] Source #
Manage your data and permissions in Google Cloud Storage
API Declaration
type BigQueryAPI = JobsInsertResource :<|> (JobsListResource :<|> (JobsGetResource :<|> (JobsQueryResource :<|> (JobsCancelResource :<|> (JobsGetQueryResultsResource :<|> (TablesInsertResource :<|> (TablesListResource :<|> (TablesPatchResource :<|> (TablesGetResource :<|> (TablesDeleteResource :<|> (TablesUpdateResource :<|> (TableDataListResource :<|> (TableDataInsertAllResource :<|> (ProjectsListResource :<|> (DataSetsInsertResource :<|> (DataSetsListResource :<|> (DataSetsPatchResource :<|> (DataSetsGetResource :<|> (DataSetsDeleteResource :<|> DataSetsUpdateResource))))))))))))))))))) Source #
Represents the entirety of the methods and resources available for the BigQuery API service.
Resources
bigquery.datasets.delete
bigquery.datasets.get
bigquery.datasets.insert
bigquery.datasets.list
bigquery.datasets.patch
bigquery.datasets.update
bigquery.jobs.cancel
bigquery.jobs.get
bigquery.jobs.getQueryResults
bigquery.jobs.insert
bigquery.jobs.list
bigquery.jobs.query
bigquery.projects.list
bigquery.tabledata.insertAll
bigquery.tabledata.list
bigquery.tables.delete
bigquery.tables.get
bigquery.tables.insert
bigquery.tables.list
bigquery.tables.patch
bigquery.tables.update
Types
JobReference
data JobReference Source #
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
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:
tlNextPageToken :: Lens' TableList (Maybe Text) Source #
A token to request the next page of results.
DataSetListDataSetsItem
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 #
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:
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
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 #
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.
tltiType :: Lens' TableListTablesItem (Maybe Text) Source #
The type of table. Possible values are: TABLE, VIEW.
TableSchema
data TableSchema Source #
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 #
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.
plNextPageToken :: Lens' ProjectList (Maybe Text) Source #
A token to request the next page of results.
plProjects :: Lens' ProjectList [ProjectListProjectsItem] Source #
Projects to which you have at least READ access.
ExplainQueryStep
data ExplainQueryStep Source #
explainQueryStep :: ExplainQueryStep Source #
Creates a value of ExplainQueryStep
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eqsSubsteps :: Lens' ExplainQueryStep [Text] Source #
Human-readable stage descriptions.
BigtableColumnFamily
data BigtableColumnFamily Source #
bigtableColumnFamily :: BigtableColumnFamily Source #
Creates a value of BigtableColumnFamily
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bcfFamilyId :: Lens' BigtableColumnFamily (Maybe Text) Source #
Identifier of the column family.
bcfColumns :: Lens' BigtableColumnFamily [BigtableColumn] Source #
- Optional
- Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
bcfOnlyReadLatest :: Lens' BigtableColumnFamily (Maybe Bool) Source #
- Optional
- If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
bcfType :: Lens' BigtableColumnFamily (Maybe Text) Source #
- Optional
- The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Defaut type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
bcfEncoding :: Lens' BigtableColumnFamily (Maybe Text) Source #
- Optional
- The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
JobStatistics
data JobStatistics Source #
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
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;
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.
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 #
- Optional
- 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.
BigtableOptions
data BigtableOptions Source #
bigtableOptions :: BigtableOptions Source #
Creates a value of BigtableOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
boIgnoreUnspecifiedColumnFamilies :: Lens' BigtableOptions (Maybe Bool) Source #
- Optional
- If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
boColumnFamilies :: Lens' BigtableOptions [BigtableColumnFamily] Source #
- Optional
- List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
ExternalDataConfiguration
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:
edcBigtableOptions :: Lens' ExternalDataConfiguration (Maybe BigtableOptions) Source #
- Optional
- Additional options if sourceFormat is set to BIGTABLE.
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 Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
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. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
edcSourceFormat :: Lens' ExternalDataConfiguration (Maybe Text) Source #
- Required
- The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
edcSchema :: Lens' ExternalDataConfiguration (Maybe TableSchema) Source #
- Optional
- The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
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. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
edcGoogleSheetsOptions :: Lens' ExternalDataConfiguration (Maybe GoogleSheetsOptions) Source #
- Optional
- Additional options if sourceFormat is set to GOOGLE_SHEETS.
edcAutodetect :: Lens' ExternalDataConfiguration (Maybe Bool) Source #
- Experimental
- Try to detect schema and format options automatically. Any option specified explicitly will be honored.
edcSourceURIs :: Lens' ExternalDataConfiguration [Text] Source #
- Required
- The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: 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. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
edcCSVOptions :: Lens' ExternalDataConfiguration (Maybe CSVOptions) Source #
Additional properties to set if sourceFormat is set to CSV.
TableReference
data TableReference Source #
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 #
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, BYTES, 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
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).
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 #
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 #
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.
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).
qrUseLegacySQL :: Lens' QueryRequest (Maybe Bool) Source #
- Experimental
- Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the values of allowLargeResults and flattenResults are ignored; query will be run as if allowLargeResults is true and flattenResults is false.
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
JobStatistics4
data JobStatistics4 Source #
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 #
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.
ExplainQueryStage
data ExplainQueryStage Source #
explainQueryStage :: ExplainQueryStage Source #
Creates a value of ExplainQueryStage
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eqsWaitRatioMax :: Lens' ExplainQueryStage (Maybe Double) Source #
Relative amount of time the slowest shard spent waiting to be scheduled.
eqsRecordsWritten :: Lens' ExplainQueryStage (Maybe Int64) Source #
Number of records written by the stage.
eqsSteps :: Lens' ExplainQueryStage [ExplainQueryStep] Source #
List of operations within the stage in dependency order (approximately chronological).
eqsWriteRatioAvg :: Lens' ExplainQueryStage (Maybe Double) Source #
Relative amount of time the average shard spent on writing output.
eqsRecordsRead :: Lens' ExplainQueryStage (Maybe Int64) Source #
Number of records read into the stage.
eqsComputeRatioAvg :: Lens' ExplainQueryStage (Maybe Double) Source #
Relative amount of time the average shard spent on CPU-bound tasks.
eqsReadRatioMax :: Lens' ExplainQueryStage (Maybe Double) Source #
Relative amount of time the slowest shard spent reading input.
eqsWaitRatioAvg :: Lens' ExplainQueryStage (Maybe Double) Source #
Relative amount of time the average shard spent waiting to be scheduled.
eqsComputeRatioMax :: Lens' ExplainQueryStage (Maybe Double) Source #
Relative amount of time the slowest shard spent on CPU-bound tasks.
eqsWriteRatioMax :: Lens' ExplainQueryStage (Maybe Double) Source #
Relative amount of time the slowest shard spent on writing output.
eqsReadRatioAvg :: Lens' ExplainQueryStage (Maybe Double) Source #
Relative amount of time the average shard spent reading input.
JobConfigurationLoad
data JobConfigurationLoad Source #
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". For Avro, specify "AVRO". 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 you're loading data from Google Cloud Datastore.
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.
jclAutodetect :: Lens' JobConfigurationLoad (Maybe Bool) Source #
- Experimental
- Indicates if we should automatically infer the options and schema for CSV and JSON sources.
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. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. 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
DataSetReference
data DataSetReference Source #
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
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:
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.
tdiarTemplateSuffix :: Lens' TableDataInsertAllRequest (Maybe Text) Source #
- Experimental
- If specified, treats the destination table as a base template, and inserts the rows into an instance table named "{destination}{templateSuffix}". BigQuery will manage creation of the instance table, using the schema of the base template table. See https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables for considerations when working with templates tables.
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
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.
plpiProjectReference :: Lens' ProjectListProjectsItem (Maybe ProjectReference) Source #
A unique reference to this project.
plpiNumericId :: Lens' ProjectListProjectsItem (Maybe Word64) Source #
The numeric ID of this project.
BigtableColumn
data BigtableColumn Source #
bigtableColumn :: BigtableColumn Source #
Creates a value of BigtableColumn
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bcQualifierEncoded :: Lens' BigtableColumn (Maybe ByteString) Source #
- Required
- Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.
bcFieldName :: Lens' BigtableColumn (Maybe Text) Source #
- Optional
- If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
bcOnlyReadLatest :: Lens' BigtableColumn (Maybe Bool) Source #
- Optional
- If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
bcType :: Lens' BigtableColumn (Maybe Text) Source #
- Optional
- The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Defaut type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
bcEncoding :: Lens' BigtableColumn (Maybe Text) Source #
- Optional
- The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
Streamingbuffer
data Streamingbuffer Source #
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
trF :: Lens' TableRow [TableCell] Source #
Represents a single row in the result set, consisting of one or more fields.
JobListJobsItem
data JobListJobsItem Source #
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.
jljiErrorResult :: Lens' JobListJobsItem (Maybe ErrorProto) Source #
A result object that will be present only if the job has failed.
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.
TimePartitioning
data TimePartitioning Source #
timePartitioning :: TimePartitioning Source #
Creates a value of TimePartitioning
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tpExpirationMs :: Lens' TimePartitioning (Maybe Int64) Source #
- Optional
- Number of milliseconds for which to keep the storage for a partition.
tpType :: Lens' TimePartitioning (Maybe Text) Source #
- Required
- The only type supported is DAY, which will generate one partition per day based on data loading time.
JobConfiguration
data JobConfiguration Source #
jcCopy :: Lens' JobConfiguration (Maybe JobConfigurationTableCopy) Source #
- Pick one
- Copies a table.
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
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.
jSelfLink :: Lens' Job (Maybe Text) Source #
- Output-only
- A URL that can be used to access this resource again.
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.
TableDataInsertAllResponseInsertErrorsItem
data TableDataInsertAllResponseInsertErrorsItem Source #
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
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 #
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:
JSONObject
data JSONObject Source #
Represents a single JSON object.
See: jsonObject
smart constructor.
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:
JobConfigurationQuery
data JobConfigurationQuery Source #
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 #
- Optional
- 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.
jcqMaximumBillingTier :: Lens' JobConfigurationQuery Int32 Source #
- Optional
- Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
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.
jcqUseLegacySQL :: Lens' JobConfigurationQuery (Maybe Bool) Source #
- Experimental
- Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the values of allowLargeResults and flattenResults are ignored; query will be run as if allowLargeResults is true and flattenResults is false.
jcqDefaultDataSet :: Lens' JobConfigurationQuery (Maybe DataSetReference) Source #
- Optional
- Specifies the default dataset to use for unqualified table names in the query.
GoogleSheetsOptions
data GoogleSheetsOptions Source #
googleSheetsOptions :: GoogleSheetsOptions Source #
Creates a value of GoogleSheetsOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gsoSkipLeadingRows :: Lens' GoogleSheetsOptions (Maybe Int64) Source #
- Optional
- The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
TableDataInsertAllRequestRowsItem
data TableDataInsertAllRequestRowsItem Source #
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
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:
JobConfigurationQueryTableDefinitions
data JobConfigurationQueryTableDefinitions Source #
- Optional
- 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.
jobConfigurationQueryTableDefinitions Source #
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
ViewDefinition
data ViewDefinition Source #
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:
vdUserDefinedFunctionResources :: Lens' ViewDefinition [UserDefinedFunctionResource] Source #
- Experimental
- Describes user-defined function resources used in the query.
vdQuery :: Lens' ViewDefinition (Maybe Text) Source #
- Required
- A query that BigQuery executes when the view is referenced.
UserDefinedFunctionResource
data UserDefinedFunctionResource Source #
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 #
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:
jSchema :: Lens' JobStatistics2 (Maybe TableSchema) Source #
- Output-only, Experimental
- The schema of the results. Present only for successful dry run of non-legacy SQL queries.
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.
jReferencedTables :: Lens' JobStatistics2 [TableReference] Source #
- Output-only, Experimental
- Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
jQueryPlan :: Lens' JobStatistics2 [ExplainQueryStage] Source #
- Output-only, Experimental
- Describes execution plan for the query as a list of stages.
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
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:
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 #
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
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:
tInsertErrors :: Lens' TableDataInsertAllResponse [TableDataInsertAllResponseInsertErrorsItem] Source #
An array of errors for rows that were not inserted.
Table
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.
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 #
- Optional
- 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.
tabLastModifiedTime :: Lens' Table (Maybe Word64) Source #
- Output-only
- The time when this table was last modified, in milliseconds since the epoch.
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.
tabTimePartitioning :: Lens' Table (Maybe TimePartitioning) Source #
- Experimental
- If specified, configures time-based partitioning for this table.
tabNumRows :: Lens' Table (Maybe Word64) Source #
- Output-only
- The number of rows of data in this table, excluding any data in the streaming buffer.
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. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.
tabNumLongTermBytes :: Lens' Table (Maybe Int64) Source #
- Output-only
- The number of bytes in the table that are considered "long-term storage".
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 #
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.
CSVOptions
data CSVOptions Source #
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 Int64) 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 #
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 #
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).
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.