Skip to main content

@swamp/gcp/bigquery

v2026.04.23.1

Google Cloud bigquery infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

gcpgoogle-cloudbigquerycloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/bigquery

rowaccesspolicies.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
filterPredicate?stringRequired. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region=\"EU\" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0
grantees?arrayOptional. Input only. The optional list of iam_member users or groups that specifies the initial members that the row-level access policy should be created with. grantees types: - "user:alice@example.com": An email address that represents a specific Google account. - "serviceAccount:my-other-app@appspot.gserviceaccount.com": An email address that represents a service account. - "group:admins@example.com": An email address that represents a Google group. - "domain:example.com":The Google Workspace domain (primary) that represents all the users of that domain. - "allAuthenticatedUsers": A special identifier that represents all service accounts and all users on the internet who have authenticated with a Google Account. This identifier includes accounts that aren\'t connected to a Google Workspace or Cloud Identity domain, such as personal Gmail accounts. Users who aren\'t authenticated, such as anonymous visitors, aren\'t included. - "allUsers":A special identifier that represents anyone who is on the internet, including authenticated and unauthenticated users. Because BigQuery requires authentication before a user can access the service, allUsers includes only authenticated users.
rowAccessPolicyReference?objectRequired. The ID of the dataset containing this row access policy.
datasetIdstringRequired. Dataset ID of the table to get the row access policy.
tableIdstringRequired. Table ID of the table to get the row access policy.
createCreate a rowAccessPolicies
getGet a rowAccessPolicies
ArgumentTypeDescription
identifierstringThe name of the rowAccessPolicies
updateUpdate rowAccessPolicies attributes
deleteDelete the rowAccessPolicies
ArgumentTypeDescription
identifierstringThe name of the rowAccessPolicies
syncSync rowAccessPolicies state from GCP
batch_deletebatch delete
ArgumentTypeDescription
force?any
policyIds?any
tables.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
biglakeConfiguration?objectOptional. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection_id can have the form `{project}.{location}.{connection_id}` or `projects/{project}/locations/{location}/connections/{connection_id}".
cloneDefinition?objectRequired. The ID of the dataset containing this table.
clustering?objectOne or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. The ordering of the clustering fields should be prioritized from most to least important for filtering purposes. For additional information, see [Introduction to clustered tables](https://cloud.google.com/bigquery/docs/clustered-tables#limitations).
defaultCollation?stringOptional. Defines the default collation specification of new STRING fields in the table. During table creation or update, if a STRING field is added to this table without explicit collation specified, then the table inherits the table default collation. A change to this field affects only fields added afterwards, and does not alter the existing fields. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
defaultRoundingMode?enumOptional. Defines the default rounding mode specification of new decimal fields (NUMERIC OR BIGNUMERIC) in the table. During table creation or update, if a decimal field is added to this table without an explicit rounding mode specified, then the field inherits the table default rounding mode. Changing this field doesn't affect existing fields.
description?stringOptional. A user-friendly description of this table.
encryptionConfiguration?objectOptional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
expirationTime?stringOptional. 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. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.
externalCatalogTableOptions?objectOptional. A connection ID that specifies the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or Amazon S3. This connection is needed to read the open source table from BigQuery. The connection_id format must be either `..` or `projects//locations//connections/`.
externalDataConfiguration?objectTry to detect schema and format options automatically. Any option specified explicitly will be honored.
friendlyName?stringOptional. A descriptive name for this table.
labels?recordThe labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
managedTableType?enumOptional. If set, overrides the default managed table type configured in the dataset.
materializedView?objectOptional. This option declares the intention to construct a materialized view that isn't refreshed incrementally. Non-incremental materialized views support an expanded range of SQL queries. The `allow_non_incremental_definition` option can't be changed after the materialized view is created.
materializedViewStatus?objectDebugging information. This property is internal to Google and should not be used.
maxStaleness?stringOptional. The maximum staleness of data that could be returned when the table (or stale MV) is queried. Staleness encoded as a string encoding of sql IntervalValue type.
model?objectDeprecated.
partitionDefinition?objectRequired. The name of the partition column.
rangePartitioning?objectRequired. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED.
requirePartitionFilter?booleanOptional. If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
resourceTags?record[Optional] The tags associated with this table. Tag keys are globally unique. See additional information on [tags](https://cloud.google.com/iam/docs/tags-access-control#definitions). An object containing a list of "key": value pairs. The key is the namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is parent id. The value is the friendly short name of the tag value, e.g. "production".
restrictions?objectOutput only. Specifies the type of dataset/table restriction.
schema?objectDeprecated.
snapshotDefinition?objectRequired. The ID of the dataset containing this table.
streamingBuffer?objectOutput only. A lower-bound estimate of the number of bytes currently in the streaming buffer.
tableConstraints?objectRequired. The column in the primary key that are referenced by the referencing_column.
tableReference?objectRequired. The ID of the dataset containing this table.
tableReplicationInfo?objectOptional. Output only. If source is a materialized view, this field signifies the last refresh time of the source.
timePartitioning?objectOptional. Number of milliseconds for which to keep the storage for a partition. A wrapper is used here because 0 is an invalid value.
view?objectOptional. Represents the dialect of the query.
datasetIdstringRequired. Dataset ID of the new table
createCreate a tables
getGet a tables
ArgumentTypeDescription
identifierstringThe name of the tables
updateUpdate tables attributes
deleteDelete the tables
ArgumentTypeDescription
identifierstringThe name of the tables
syncSync tables state from GCP
tabledata.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a tabledata
ArgumentTypeDescription
identifierstringThe name of the tabledata
syncSync tabledata state from GCP
insert_allinsert all
ArgumentTypeDescription
ignoreUnknownValues?any
kind?any
rows?any
skipInvalidRows?any
templateSuffix?any
traceId?any
projects.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a projects
ArgumentTypeDescription
identifierstringThe name of the projects
syncSync projects state from GCP
get_service_accountget service account
jobs.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
configuration?objectOptional. 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.
jobCreationReason?objectOutput only. Specifies the high level reason why a Job was created.
jobReference?objectRequired. 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.
statistics?objectOutput only. [TrustedTester] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
status?objectDebugging information. This property is internal to Google and should not be used.
createCreate a jobs
getGet a jobs
ArgumentTypeDescription
identifierstringThe name of the jobs
deleteDelete the jobs
ArgumentTypeDescription
identifierstringThe name of the jobs
syncSync jobs state from GCP
cancelcancel
get_query_resultsget query results
queryquery
ArgumentTypeDescription
connectionProperties?any
continuous?any
createSession?any
defaultDataset?any
destinationEncryptionConfiguration?any
dryRun?any
formatOptions?any
jobCreationMode?any
jobTimeoutMs?any
kind?any
labels?any
location?any
maxResults?any
maxSlots?any
maximumBytesBilled?any
parameterMode?any
preserveNulls?any
query?any
queryParameters?any
requestId?any
reservation?any
timeoutMs?any
useLegacySql?any
useQueryCache?any
writeIncrementalResults?any
models.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
creationTime?stringOutput only. The time when this model was created, in millisecs since the epoch.
defaultTrialId?stringOutput only. The default trial_id to use in TVFs when the trial_id is not passed in. For single-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the best trial ID. For multi-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the smallest trial ID among all Pareto optimal trials.
description?stringOptional. A user-friendly description of this model.
encryptionConfiguration?objectOptional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
etag?stringOutput only. A hash of this resource.
expirationTime?stringOptional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models.
featureColumns?arrayOptional. The name of this field. Can be absent for struct fields.
friendlyName?stringOptional. A descriptive name for this model.
hparamSearchSpaces?objectCanididates for the string or enum parameter in lower case.
hparamTrials?arrayEnding time of the trial.
labelColumns?arrayOptional. The name of this field. Can be absent for struct fields.
labels?recordThe labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
lastModifiedTime?stringOutput only. The time when this model was last modified, in millisecs since the epoch.
location?stringOutput only. The geographic location where the model resides. This value is inherited from the dataset.
modelReference?objectRequired. The ID of the dataset containing this model.
modelType?enumOutput only. Type of the model resource.
optimalTrialIds?arrayOutput only. For single-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it only contains the best trial. For multi-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it contains all Pareto optimal trials sorted by trial_id.
remoteModelInfo?objectOutput only. Fully qualified name of the user-provided connection object of the remote model. Format: ` "projects/{project_id}/locations/{location_id}/connections/{connection_id}" `
trainingRuns?arrayClass label for this set of global explanations. Will be empty/null for binary logistic and linear regression models. Sorted alphabetically in descending order.
transformColumns?arrayOutput only. Name of the column.
getGet a models
ArgumentTypeDescription
identifierstringThe name of the models
updateUpdate models attributes
deleteDelete the models
ArgumentTypeDescription
identifierstringThe name of the models
syncSync models state from GCP
datasets.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
access?arrayOptional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
datasetReference?objectRequired. 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.
defaultCollation?stringOptional. Defines the default collation specification of future tables created in the dataset. If a table is created in this dataset without table-level default collation, then the table inherits the dataset default collation, which is applied to the string fields that do not have explicit collation specified. A change to this field affects only tables created afterwards, and does not alter the existing tables. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
defaultEncryptionConfiguration?objectOptional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
defaultPartitionExpirationMs?stringThis default partition expiration, expressed in milliseconds. When new time-partitioned tables are created in a dataset where this property is set, the table will inherit this value, propagated as the `TimePartitioning.expirationMs` property on the new table. If you set `TimePartitioning.expirationMs` explicitly when creating a table, the `defaultPartitionExpirationMs` of the containing dataset is ignored. When creating a partitioned table, if `defaultPartitionExpirationMs` is set, the `defaultTableExpirationMs` value is ignored and the table will not be inherit a table expiration deadline.
defaultRoundingMode?enumOptional. Defines the default rounding mode specification of new tables created within this dataset. During table creation, if this field is specified, the table within this dataset will inherit the default rounding mode of the dataset. Setting the default rounding mode on a table overrides this option. Existing tables in the dataset are unaffected. If columns are defined during that table creation, they will immediately inherit the table's default rounding mode, unless otherwise specified.
defaultTableExpirationMs?stringOptional. The default lifetime of all tables in the dataset, in milliseconds. The minimum lifetime value is 3600000 milliseconds (one hour). To clear an existing default expiration with a PATCH request, set to 0. 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.
description?stringOptional. A user-friendly description of the dataset.
externalCatalogDatasetOptions?objectOptional. The storage location URI for all tables in the dataset. Equivalent to hive metastore's database locationUri. Maximum length of 1024 characters.
externalDatasetReference?objectRequired. The connection id that is used to access the external_source. Format: projects/{project_id}/locations/{location_id}/connections/{connection_id}
friendlyName?stringOptional. A descriptive name for the dataset.
isCaseInsensitive?booleanOptional. TRUE if the dataset and its table names are case-insensitive, otherwise FALSE. By default, this is FALSE, which means the dataset and its table names are case-sensitive. This field does not affect routine references.
labels?recordThe labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See [Creating and Updating Dataset Labels](https://cloud.google.com/bigquery/docs/creating-managing-labels#creating_and_updating_dataset_labels) for more information.
linkedDatasetMetadata?objectOutput only. Specifies whether Linked Dataset is currently in a linked state or not.
linkedDatasetSource?objectRequired. 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.
location?stringThe geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
maxTimeTravelHours?stringOptional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set.
resourceTags?recordOptional. The [tags](https://cloud.google.com/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details.
restrictions?objectOutput only. Specifies the type of dataset/table restriction.
storageBillingModel?enumOptional. Updates storage_billing_model for the dataset.
accessPolicyVersion?stringOptional. The version of the provided access policy schema. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. This version refers to the schema version of the access policy and not the version of access policy. This field's value can be equal or more than the access policy schema provided in the request. For example, * Requests with conditional access policy binding in datasets must specify version 3. * But dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. If unset or if 0 or 1 value is used for dataset with conditional bindings, request will be rejected. This field will be mapped to IAM Policy version (https://cloud.google.com/iam/docs/policies#versions) and will be used to set policy in IAM.
createCreate a datasets
getGet a datasets
ArgumentTypeDescription
identifierstringThe name of the datasets
updateUpdate datasets attributes
deleteDelete the datasets
ArgumentTypeDescription
identifierstringThe name of the datasets
syncSync datasets state from GCP
undeleteundelete
ArgumentTypeDescription
deletionTime?any
routines.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
arguments?arrayOptional. Defaults to FIXED_TYPE.
buildStatus?objectOutput only. The time taken for the image build. Populated only after the build succeeds or fails.
dataGovernanceType?enumOptional. If set to `DATA_MASKING`, the function is validated and made available as a masking function. For more information, see [Create custom masking routines](https://cloud.google.com/bigquery/docs/user-defined-functions#custom-mask).
definitionBody?stringRequired. The body of the routine. For functions, this is the expression in the AS clause. If `language = "SQL"`, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\\n", y))` The definition_body is `concat(x, "\\n", y)` (\\n is not replaced with linebreak). If `language="JAVASCRIPT"`, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS \'return "\\n";\\n\'` The definition_body is `return "\\n";\\n` Note that both \\n are replaced with linebreaks. If `definition_body` references another routine, then that routine must be fully qualified with its project ID.
description?stringOptional. The description of the routine, if defined.
determinismLevel?enumOptional. The determinism level of the JavaScript UDF, if defined.
externalRuntimeOptions?objectOptional. Amount of CPU provisioned for a Python UDF container instance. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits)
importedLibraries?arrayOptional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.
language?enumOptional. Defaults to "SQL" if remote_function_options field is absent, not set otherwise.
pythonOptions?objectRequired. The name of the function defined in Python code as the entry point when the Python UDF is invoked.
remoteFunctionOptions?objectFully qualified name of the user-provided connection object which holds the authentication information to send requests to the remote service. Format: ` "projects/{projectId}/locations/{locationId}/connections/{connectionId}" `
returnTableType?objectOptional. The name of this field. Can be absent for struct fields.
returnType?objectCircular reference to StandardSqlDataType
routineReference?objectRequired. The ID of the dataset containing this routine.
routineType?enumRequired. The type of routine.
securityMode?enumOptional. The security mode of the routine, if defined. If not defined, the security mode is automatically determined from the routine's configuration.
sparkOptions?objectArchive files to be extracted into the working directory of each executor. For more information about Apache Spark, see [Apache Spark](https://spark.apache.org/docs/latest/index.html).
strictMode?booleanOptional. Use this option to catch many common errors. Error checking is not exhaustive, and successfully creating a procedure doesn't guarantee that the procedure will successfully execute at runtime. If `strictMode` is set to `TRUE`, the procedure body is further checked for errors such as non-existent tables or columns. The `CREATE PROCEDURE` statement fails if the body fails any of these checks. If `strictMode` is set to `FALSE`, the procedure body is checked only for syntax. For procedures that invoke themselves recursively, specify `strictMode=FALSE` to avoid non-existent procedure errors during validation. Default value is `TRUE`.
datasetIdstringRequired. Dataset ID of the new routine
createCreate a routines
getGet a routines
ArgumentTypeDescription
identifierstringThe name of the routines
updateUpdate routines attributes
deleteDelete the routines
ArgumentTypeDescription
identifierstringThe name of the routines
syncSync routines state from GCP