bigquery library

Classes

Argument
Input/output argument of a function or a stored procedure.
ArgumentResponse
Input/output argument of a function or a stored procedure.
AuditConfig
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": "user:aliya@example.com" } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
AuditConfigResponse
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": "user:aliya@example.com" } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
AuditLogConfig
Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
AuditLogConfigResponse
Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
AvroOptions
AvroOptionsResponse
BiEngineReasonResponse
BiEngineStatisticsResponse
BigLakeConfiguration
BigLakeConfigurationResponse
BigQueryModelTrainingResponse
BigtableColumn
BigtableColumnFamily
BigtableColumnFamilyResponse
BigtableColumnResponse
BigtableOptions
BigtableOptionsResponse
Binding
Associates members, or principals, with a role.
BindingResponse
Associates members, or principals, with a role.
BqmlIterationResult
BqmlIterationResultResponse
BqmlTrainingRun
BqmlTrainingRunResponse
BqmlTrainingRunTrainingOptions
Output-only, Beta Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.
BqmlTrainingRunTrainingOptionsResponse
Output-only, Beta Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.
CloneDefinitionResponse
Clustering
ClusteringResponse
ConnectionProperty
ConnectionPropertyResponse
CsvOptions
CsvOptionsResponse
DataMaskingStatisticsResponse
Dataset
Creates a new empty dataset. Auto-naming is currently not supported for this resource.
DatasetAccessEntry
DatasetAccessEntryResponse
DatasetAccessItem
DatasetAccessItemResponse
DatasetArgs
The set of arguments for Dataset. The set of arguments for Dataset.
DatasetReference
DatasetReferenceResponse
DatasetTagsItem
DatasetTagsItemResponse
DestinationTableProperties
DestinationTablePropertiesResponse
DmlStatisticsResponse
EncryptionConfiguration
EncryptionConfigurationResponse
ErrorProtoResponse
ExplainQueryStageResponse
ExplainQueryStepResponse
Expr
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
ExprResponse
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
ExternalDataConfiguration
ExternalDataConfigurationResponse
ExternalDatasetReference
ExternalDatasetReferenceResponse
GetDatasetArgs
Arguments for getDataset. Arguments for getDataset.
GetDatasetResult
Result data returned by getDataset.
GetJobArgs
Arguments for getJob. Arguments for getJob.
GetJobResult
Result data returned by getJob.
GetRoutineArgs
Arguments for getRoutine. Arguments for getRoutine.
GetRoutineResult
Result data returned by getRoutine.
GetTableArgs
Arguments for getTable. Arguments for getTable.
GetTableIamPolicyArgs
Arguments for getTableIamPolicy. Arguments for getTableIamPolicy.
GetTableIamPolicyResult
Result data returned by getTableIamPolicy.
GetTableResult
Result data returned by getTable.
GoogleSheetsOptions
GoogleSheetsOptionsResponse
HivePartitioningOptions
HivePartitioningOptionsResponse
IndexUnusedReasonResponse
IterationResultResponse
Job
Starts a new asynchronous job. Requires the Can View project role. Auto-naming is currently not supported for this resource.
JobArgs
The set of arguments for Job. The set of arguments for Job.
JobConfiguration
JobConfigurationExtract
JobConfigurationExtractResponse
JobConfigurationLoad
JobConfigurationLoadResponse
JobConfigurationQuery
JobConfigurationQueryResponse
JobConfigurationResponse
JobConfigurationTableCopy
JobConfigurationTableCopyResponse
JobReference
JobReferenceResponse
JobStatistics2ReservationUsageItemResponse
JobStatistics2Response
JobStatistics3Response
JobStatistics4Response
JobStatistics5Response
JobStatisticsReservationUsageItemResponse
JobStatisticsResponse
JobStatusResponse
JsonOptions
JsonOptionsResponse
MaterializedViewDefinition
MaterializedViewDefinitionResponse
MlStatisticsResponse
ModelDefinition
ModelDefinitionModelOptions
Output-only, Beta Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.
ModelDefinitionModelOptionsResponse
Output-only, Beta Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.
ModelDefinitionResponse
ModelReference
ModelReferenceResponse
ParquetOptions
ParquetOptionsResponse
QueryParameter
QueryParameterResponse
QueryParameterType
QueryParameterTypeResponse
QueryParameterTypeStructTypesItem
QueryParameterTypeStructTypesItemResponse
QueryParameterValue
QueryParameterValueResponse
QueryTimelineSampleResponse
RangePartitioning
RangePartitioningRange
TrustedTester Required Defines the ranges for range partitioning.
RangePartitioningRangeResponse
TrustedTester Required Defines the ranges for range partitioning.
RangePartitioningResponse
RemoteFunctionOptions
Options for a remote user-defined function.
RemoteFunctionOptionsResponse
Options for a remote user-defined function.
Routine
Creates a new routine in the dataset. Auto-naming is currently not supported for this resource.
RoutineArgs
The set of arguments for Routine. The set of arguments for Routine.
RoutineReference
RoutineReferenceResponse
RowAccessPolicyReferenceResponse
RowLevelSecurityStatisticsResponse
ScriptStackFrameResponse
ScriptStatisticsResponse
SearchStatisticsResponse
SessionInfoResponse
SnapshotDefinitionResponse
SparkLoggingInfoResponse
SparkOptions
Options for a user-defined Spark routine.
SparkOptionsResponse
Options for a user-defined Spark routine.
SparkStatisticsResponse
StandardSqlDataType
The data type of a variable such as a function argument. Examples include: * INT64: {"typeKind": "INT64"} * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } } }
StandardSqlDataTypeResponse
The data type of a variable such as a function argument. Examples include: * INT64: {"typeKind": "INT64"} * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } } }
StandardSqlField
A field or a column.
StandardSqlFieldResponse
A field or a column.
StandardSqlStructType
The representation of a SQL STRUCT type.
StandardSqlStructTypeResponse
The representation of a SQL STRUCT type.
StandardSqlTableType
A table type
StandardSqlTableTypeResponse
A table type
StreamingbufferResponse
Table
Creates a new, empty table in the dataset. Auto-naming is currently not supported for this resource.
TableArgs
The set of arguments for Table. The set of arguments for Table.
TableConstraints
TableConstraintsForeignKeysItem
TableConstraintsForeignKeysItemColumnReferencesItem
TableConstraintsForeignKeysItemColumnReferencesItemResponse
TableConstraintsForeignKeysItemReferencedTable
TableConstraintsForeignKeysItemReferencedTableResponse
TableConstraintsForeignKeysItemResponse
TableConstraintsPrimaryKey
Optional The primary key of the table.
TableConstraintsPrimaryKeyResponse
Optional The primary key of the table.
TableConstraintsResponse
TableFieldSchema
TableFieldSchemaCategories
Optional The categories attached to this field, used for field-level access control.
TableFieldSchemaCategoriesResponse
Optional The categories attached to this field, used for field-level access control.
TableFieldSchemaPolicyTags
TableFieldSchemaPolicyTagsResponse
TableFieldSchemaRangeElementType
Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: - DATE - DATETIME - TIMESTAMP
TableFieldSchemaRangeElementTypeResponse
Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: - DATE - DATETIME - TIMESTAMP
TableFieldSchemaResponse
TableIamBinding
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
TableIamBindingArgs
The set of arguments for TableIamBinding. The set of arguments for TableIamBinding.
TableIamMember
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
TableIamMemberArgs
The set of arguments for TableIamMember. The set of arguments for TableIamMember.
TableIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
TableIamPolicyArgs
The set of arguments for TableIamPolicy. The set of arguments for TableIamPolicy.
TableReference
TableReferenceResponse
TableSchema
TableSchemaResponse
TimePartitioning
TimePartitioningResponse
TransactionInfoResponse
UserDefinedFunctionResource
This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE TEMPORARY FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions
UserDefinedFunctionResourceResponse
This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE TEMPORARY FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions
ViewDefinition
ViewDefinitionResponse

Enums

ArgumentArgumentKind
Optional. Defaults to FIXED_TYPE.
ArgumentMode
Optional. Specifies whether the argument is input or output. Can be set for procedures only.
AuditLogConfigLogType
The log type that this config enables.
DatasetAccessEntryTargetTypesItem
RoutineDataGovernanceType
Optional. If set to DATA_MASKING, the function is validated and made available as a masking function. For more information, see Create custom masking routines.
RoutineDeterminismLevel
Optional. The determinism level of the JavaScript UDF, if defined.
RoutineLanguage
Optional. Defaults to "SQL" if remote_function_options field is absent, not set otherwise.
RoutineRoutineType
Required. The type of routine.
RoutineSecurityMode
Optional. The security mode of the routine, if defined. If not defined, the security mode is automatically determined from the routine's configuration.
StandardSqlDataTypeTypeKind
Required. The top level type of this field. Can be any GoogleSQL data type (e.g., "INT64", "DATE", "ARRAY").

Functions

getDataset(GetDatasetArgs args, {InvokeOptions? options}) → Future<GetDatasetResult>
Returns the dataset specified by datasetID. args Arguments passed to this invoke. Arguments for getDataset. options Invoke options controlling this call.
getJob(GetJobArgs args, {InvokeOptions? options}) → Future<GetJobResult>
Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role. args Arguments passed to this invoke. Arguments for getJob. options Invoke options controlling this call.
getRoutine(GetRoutineArgs args, {InvokeOptions? options}) → Future<GetRoutineResult>
Gets the specified routine resource by routine ID. args Arguments passed to this invoke. Arguments for getRoutine. options Invoke options controlling this call.
getTable(GetTableArgs args, {InvokeOptions? options}) → Future<GetTableResult>
Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table. args Arguments passed to this invoke. Arguments for getTable. options Invoke options controlling this call.
getTableIamPolicy(GetTableIamPolicyArgs args, {InvokeOptions? options}) → Future<GetTableIamPolicyResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getTableIamPolicy. options Invoke options controlling this call.