MCP Tools Reference: bigquery.googleapis.com

Ferramenta: get_table_info

Obter informações de metadados sobre uma tabela do BigQuery.

O exemplo seguinte demonstra como usar curl para invocar a ferramenta MCP get_table_info.

Pedido Curl
                  
curl --location 'https://bigquery.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "get_table_info",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'
                

Esquema de entrada

Pedido de uma mesa.

Representação JSON
{
  "projectId": string,
  "datasetId": string,
  "tableId": string
}
Campos
projectId

string

Obrigatório. ID do projeto do pedido de tabela.

datasetId

string

Obrigatório. ID do conjunto de dados do pedido de tabela.

tableId

string

Obrigatório. ID da tabela do pedido de tabela.

Esquema de saída

Representação JSON
{
  "kind": string,
  "etag": string,
  "id": string,
  "selfLink": string,
  "tableReference": {
    object (TableReference)
  },
  "friendlyName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "schema": {
    object (TableSchema)
  },
  "timePartitioning": {
    object (TimePartitioning)
  },
  "rangePartitioning": {
    object (RangePartitioning)
  },
  "clustering": {
    object (Clustering)
  },
  "requirePartitionFilter": boolean,
  "numBytes": string,
  "numPhysicalBytes": string,
  "numLongTermBytes": string,
  "numRows": string,
  "creationTime": string,
  "expirationTime": string,
  "lastModifiedTime": string,
  "type": string,
  "view": {
    object (ViewDefinition)
  },
  "materializedView": {
    object (MaterializedViewDefinition)
  },
  "materializedViewStatus": {
    object (MaterializedViewStatus)
  },
  "externalDataConfiguration": {
    object (ExternalDataConfiguration)
  },
  "biglakeConfiguration": {
    object (BigLakeConfiguration)
  },
  "managedTableType": enum (ManagedTableType),
  "location": string,
  "streamingBuffer": {
    object (Streamingbuffer)
  },
  "encryptionConfiguration": {
    object (EncryptionConfiguration)
  },
  "snapshotDefinition": {
    object (SnapshotDefinition)
  },
  "defaultCollation": string,
  "defaultRoundingMode": enum (RoundingMode),
  "cloneDefinition": {
    object (CloneDefinition)
  },
  "numTimeTravelPhysicalBytes": string,
  "numTotalLogicalBytes": string,
  "numActiveLogicalBytes": string,
  "numLongTermLogicalBytes": string,
  "numCurrentPhysicalBytes": string,
  "numTotalPhysicalBytes": string,
  "numActivePhysicalBytes": string,
  "numLongTermPhysicalBytes": string,
  "numPartitions": string,
  "maxStaleness": string,
  "restrictions": {
    object (RestrictionConfig)
  },
  "tableConstraints": {
    object (TableConstraints)
  },
  "resourceTags": {
    string: string,
    ...
  },
  "tableReplicationInfo": {
    object (TableReplicationInfo)
  },
  "replicas": [
    {
      object (TableReference)
    }
  ],
  "externalCatalogTableOptions": {
    object (ExternalCatalogTableOptions)
  },

  // Union field _partition_definition can be only one of the following:
  "partitionDefinition": {
    object (PartitioningDefinition)
  }
  // End of list of possible types for union field _partition_definition.
}
Campos
kind

string

O tipo de ID do recurso.

etag

string

Apenas saída. Um hash deste recurso.

id

string

Apenas saída. Um ID opaco que identifica exclusivamente a tabela.

selfLink

string

Apenas saída. Um URL que pode ser usado para aceder novamente a este recurso.

tableReference

object (TableReference)

Obrigatório. Referência que descreve o ID desta tabela.

friendlyName

string

Opcional. Um nome descritivo para esta tabela.

description

string

Opcional. Uma descrição desta tabela de fácil utilização.

labels

map (key: string, value: string)

As etiquetas associadas a esta tabela. Pode usá-las para organizar e agrupar as suas tabelas. As chaves e os valores das etiquetas não podem ter mais de 63 carateres e só podem conter letras minúsculas, carateres numéricos, sublinhados e travessões. São permitidos carateres internacionais. Os valores das etiquetas são opcionais. As chaves de etiquetas têm de começar com uma letra e cada etiqueta na lista tem de ter uma chave diferente.

Um objeto que contém uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

schema

object (TableSchema)

Opcional. Descreve o esquema desta tabela.

timePartitioning

object (TimePartitioning)

Se for especificado, configura a partição baseada no tempo para esta tabela.

rangePartitioning

object (RangePartitioning)

Se for especificado, configura a partição por intervalo para esta tabela.

clustering

object (Clustering)

Especificação de clustering para a tabela. Tem de ser especificado com a partição baseada no tempo. Os dados na tabela são primeiro particionados e, posteriormente, agrupados.

requirePartitionFilter

boolean

Opcional. Se for definida como verdadeira, as consultas sobre esta tabela requerem a especificação de um filtro de partição que possa ser usado para a eliminação de partições.

numBytes

string (Int64Value format)

Apenas saída. O tamanho desta tabela em bytes lógicos, excluindo quaisquer dados na memória intermédia de streaming.

numPhysicalBytes

string (Int64Value format)

Apenas saída. O tamanho físico desta tabela em bytes. Isto inclui o armazenamento usado para a viagem no tempo.

numLongTermBytes

string (Int64Value format)

Apenas saída. O número de bytes lógicos na tabela que são considerados "armazenamento a longo prazo".

numRows

string (UInt64Value format)

Apenas saída. O número de linhas de dados nesta tabela, excluindo quaisquer dados no buffer de streaming.

creationTime

string (int64 format)

Apenas saída. A hora em que esta tabela foi criada, em milissegundos desde a época.

expirationTime

string (Int64Value format)

Opcional. A hora em que esta tabela expira, em milissegundos desde a época. Se não estiver presente, a tabela persiste indefinidamente. As tabelas expiradas são eliminadas e o respetivo armazenamento é recuperado. A propriedade defaultTableExpirationMs do conjunto de dados de encapsulamento pode ser usada para definir um valor expirationTime predefinido em tabelas recém-criadas.

lastModifiedTime

string (uint64 format)

Apenas saída. A hora em que esta tabela foi modificada pela última vez, em milissegundos desde a época.

type

string

Apenas saída. Descreve o tipo de tabela. Os seguintes valores são suportados:

  • TABLE: uma tabela normal do BigQuery.
  • VIEW: uma tabela virtual definida por uma consulta SQL.
  • EXTERNAL: uma tabela que faz referência a dados armazenados num sistema de armazenamento externo, como o Google Cloud Storage.
  • MATERIALIZED_VIEW: uma vista pré-calculada definida por uma consulta SQL.
  • SNAPSHOT: uma tabela do BigQuery imutável que preserva o conteúdo de uma tabela base num momento específico. Veja informações adicionais sobre resumos de tabelas.

O valor predefinido é TABLE.

view

object (ViewDefinition)

Opcional. A definição da vista.

materializedView

object (MaterializedViewDefinition)

Opcional. A definição da vista materializada.

materializedViewStatus

object (MaterializedViewStatus)

Apenas saída. O estado da vista materializada.

externalDataConfiguration

object (ExternalDataConfiguration)

Opcional. Descreve o formato dos dados, a localização e outras propriedades de uma tabela armazenada fora do BigQuery. Ao definir estas propriedades, a origem de dados pode ser consultada como se fosse uma tabela padrão do BigQuery.

biglakeConfiguration

object (BigLakeConfiguration)

Opcional. Especifica a configuração de uma tabela do BigQuery para o Apache Iceberg.

managedTableType

enum (ManagedTableType)

Opcional. Se for definido, substitui o tipo de tabela gerida predefinido configurado no conjunto de dados.

location

string

Apenas saída. A localização geográfica onde a tabela reside. Este valor é herdado do conjunto de dados.

streamingBuffer

object (Streamingbuffer)

Apenas saída. Contém informações sobre o buffer de streaming desta tabela, se existir. Este campo está ausente se a tabela não estiver a ser transmitida ou se não existirem dados no buffer de streaming.

encryptionConfiguration

object (EncryptionConfiguration)

Configuração de encriptação personalizada (por exemplo, Chaves do Cloud KMS).

snapshotDefinition

object (SnapshotDefinition)

Apenas saída. Contém informações sobre o resumo. Este valor é definido através da criação de instantâneos.

defaultCollation

string

Opcional. Define a especificação de ordenação predefinida de novos campos STRING na tabela. Durante a criação ou a atualização de uma tabela, se for adicionado um campo STRING a esta tabela sem uma ordenação explícita especificada, a tabela herda a ordenação predefinida da tabela. Uma alteração a este campo afeta apenas os campos adicionados posteriormente e não altera os campos existentes. Os seguintes valores são suportados:

  • 'und:ci': local indeterminado, sem distinção entre maiúsculas e minúsculas.
  • "": string vazia. Comportamento predefinido sensível a maiúsculas e minúsculas.
defaultRoundingMode

enum (RoundingMode)

Opcional. Define a especificação do modo de arredondamento predefinido de novos campos decimais (NUMERIC OR BIGNUMERIC) na tabela. Durante a criação ou a atualização da tabela, se for adicionado um campo decimal a esta tabela sem um modo de arredondamento explícito especificado, o campo herda o modo de arredondamento predefinido da tabela. A alteração deste campo não afeta os campos existentes.

cloneDefinition

object (CloneDefinition)

Apenas saída. Contém informações sobre o clone. Este valor é definido através da operação de clonagem.

numTimeTravelPhysicalBytes

string (Int64Value format)

Apenas saída. Número de bytes físicos usados pelo armazenamento de viagem no tempo (dados eliminados ou alterados). Estes dados não são mantidos em tempo real e podem ter um atraso de alguns segundos a alguns minutos.

numTotalLogicalBytes

string (Int64Value format)

Apenas saída. Número total de bytes lógicos na tabela ou na vista materializada.

numActiveLogicalBytes

string (Int64Value format)

Apenas saída. Número de bytes lógicos com menos de 90 dias.

numLongTermLogicalBytes

string (Int64Value format)

Apenas saída. Número de bytes lógicos com mais de 90 dias.

numCurrentPhysicalBytes

string (Int64Value format)

Apenas saída. Número de bytes físicos usados pelo armazenamento de dados em direto atual. Estes dados não são mantidos em tempo real e podem ter um atraso de alguns segundos a alguns minutos.

numTotalPhysicalBytes

string (Int64Value format)

Apenas saída. O tamanho físico desta tabela em bytes. Isto também inclui o armazenamento usado para a viagem no tempo. Estes dados não são mantidos em tempo real e podem ter um atraso de alguns segundos a alguns minutos.

numActivePhysicalBytes

string (Int64Value format)

Apenas saída. Número de bytes físicos com menos de 90 dias. Estes dados não são mantidos em tempo real e podem ter um atraso de alguns segundos a alguns minutos.

numLongTermPhysicalBytes

string (Int64Value format)

Apenas saída. Número de bytes físicos com mais de 90 dias. Estes dados não são mantidos em tempo real e podem ter um atraso de alguns segundos a alguns minutos.

numPartitions

string (Int64Value format)

Apenas saída. O número de partições presentes na tabela ou na vista materializada. Estes dados não são mantidos em tempo real e podem ter um atraso de alguns segundos a alguns minutos.

maxStaleness

string

Opcional. O nível máximo de desatualização dos dados que podem ser devolvidos quando a tabela (ou a vista materializada desatualizada) é consultada. Obsolecência codificada como uma codificação de string do tipo IntervalValue SQL.

restrictions

object (RestrictionConfig)

Opcional. Apenas saída. Configuração de restrição para a tabela. Se estiver definida, restringe determinados acessos na tabela com base na configuração. Consulte o artigo Saída de dados para ver mais detalhes.

tableConstraints

object (TableConstraints)

Opcional. Informações sobre a chave principal e a chave externa das tabelas

resourceTags

map (key: string, value: string)

Opcional. As etiquetas anexadas a esta tabela. As chaves de etiquetas são globalmente únicas. Espera-se que a chave da etiqueta esteja no formato de espaço de nomes, por exemplo, "123456789012/environment", em que 123456789012 é o ID do recurso de organização ou projeto principal desta chave de etiqueta. O valor da etiqueta deve ser o nome abreviado, por exemplo, "Produção". Consulte as Definições de etiquetas para ver mais detalhes.

Um objeto que contém uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

tableReplicationInfo

object (TableReplicationInfo)

Opcional. Informações de replicação da tabela para a tabela criada com DDL AS REPLICA, como: CREATE MATERIALIZED VIEW mv1 AS REPLICA OF src_mv

replicas[]

object (TableReference)

Opcional. Apenas saída. Referências de tabelas de todas as réplicas atualmente ativas na tabela.

externalCatalogTableOptions

object (ExternalCatalogTableOptions)

Opcional. Opções que definem a tabela compatível com código aberto.

Campo de união _partition_definition.

_partition_definition só pode ser uma das seguintes opções:

partitionDefinition

object (PartitioningDefinition)

Opcional. As informações de partição para todos os formatos de tabelas, incluindo tabelas particionadas geridas, tabelas particionadas do Hive, tabelas particionadas do Iceberg e tabelas particionadas do metastore. Este campo só é preenchido para tabelas particionadas da metastore. Para outros formatos de tabela, este é um campo apenas de saída.

Representação JSON
{
  "projectId": string,
  "datasetId": string,
  "tableId": string,
  "projectIdAlternative": [
    string
  ],
  "datasetIdAlternative": [
    string
  ],
  "tableIdAlternative": [
    string
  ]
}
Campos
projectId

string

Obrigatório. O ID do projeto que contém esta tabela.

datasetId

string

Obrigatório. O ID do conjunto de dados que contém esta tabela.

tableId

string

Obrigatório. O ID da tabela. O ID pode conter carateres Unicode nas categorias L (letra), M (marca), N (número), Pc (conetor, incluindo sublinhado), Pd (traço) e Zs (espaço). Para mais informações, consulte Categoria geral. O comprimento máximo é de 1024 carateres. Determinadas operações permitem adicionar um sufixo ao ID da tabela com um decorador de partições, como sample_table$20190123.

projectIdAlternative[]

string

Este campo não deve ser usado.

datasetIdAlternative[]

string

Este campo não deve ser usado.

tableIdAlternative[]

string

Este campo não deve ser usado.

Representação JSON
{
  "value": string
}
Campos
value

string

O valor de string.

Representação JSON
{
  "key": string,
  "value": string
}
Campos
key

string

value

string

Representação JSON
{
  "fields": [
    {
      object (TableFieldSchema)
    }
  ],
  "foreignTypeInfo": {
    object (ForeignTypeInfo)
  }
}
Campos
fields[]

object (TableFieldSchema)

Descreve os campos numa tabela.

foreignTypeInfo

object (ForeignTypeInfo)

Opcional. Especifica os metadados da definição do tipo de dados externo no esquema de campos (TableFieldSchema.foreign_type_definition).

Representação JSON
{
  "name": string,
  "type": string,
  "mode": string,
  "fields": [
    {
      object (TableFieldSchema)
    }
  ],
  "description": string,
  "policyTags": {
    object (PolicyTagList)
  },
  "dataPolicies": [
    {
      object (DataPolicyOption)
    }
  ],
  "nameAlternative": [
    string
  ],
  "maxLength": string,
  "precision": string,
  "scale": string,
  "timestampPrecision": string,
  "roundingMode": enum (RoundingMode),
  "collation": string,
  "defaultValueExpression": string,
  "rangeElementType": {
    object (FieldElementType)
  },
  "foreignTypeDefinition": string
}
Campos
name

string

Obrigatório. O nome do campo. O nome tem de conter apenas letras (a-z, A-Z), números (0-9) ou sublinhados (_) e tem de começar por uma letra ou um sublinhado. O comprimento máximo é de 300 carateres.

type

string

Obrigatório. O tipo de dados do campo. Os valores possíveis incluem:

  • STRING
  • BYTES
  • INTEGER (ou INT64)
  • FLOAT (ou FLOAT64)
  • BOOLEANO (ou BOOL)
  • TIMESTAMP
  • DATA
  • HORA
  • DATA/HORA
  • GEOGRAPHY
  • NUMERIC
  • BIGNUMERIC
  • JSON
  • RECORD (ou STRUCT)
  • RANGE

A utilização de RECORD/STRUCT indica que o campo contém um esquema aninhado.

mode

string

Opcional. O campo mode. Os valores possíveis incluem NULLABLE, REQUIRED e REPEATED. O valor predefinido é NULLABLE.

fields[]

object (TableFieldSchema)

Opcional. Descreve os campos do esquema aninhado se a propriedade de tipo estiver definida como RECORD.

description

string

Opcional. A descrição do campo. O comprimento máximo é de 1024 carateres.

policyTags

object (PolicyTagList)

Opcional. As etiquetas de políticas anexadas a este campo, usadas para o controlo de acesso ao nível do campo. Se não estiver definido, o valor predefinido é policy_tags vazio.

dataPolicies[]

object (DataPolicyOption)

Opcional. Políticas de dados anexadas a este campo, usadas para o controlo de acesso ao nível do campo.

nameAlternative[]

string

Este campo não deve ser usado.

maxLength

string (int64 format)

Opcional. Comprimento máximo dos valores deste campo para STRINGS ou BYTES.

Se max_length não for especificado, não é imposta nenhuma restrição de comprimento máximo neste campo.

Se type = "STRING", max_length representa o comprimento máximo UTF-8 das strings neste campo.

Se type = "BYTES", max_length representa o número máximo de bytes neste campo.

Não é válido definir este campo se o tipo for diferente de "STRING" e "BYTES".

precision

string (int64 format)

Opcional. Restrições de precisão (número máximo de dígitos totais na base 10) e escala (número máximo de dígitos na parte fracionária na base 10) para valores deste campo para NUMERIC ou BIGNUMERIC.

Não é válido definir a precisão ou a escala se o tipo for diferente de "NUMERIC" e "BIGNUMERIC".

Se a precisão e a escala não forem especificadas, não é imposta nenhuma restrição de intervalo de valores neste campo, na medida em que os valores são permitidos pelo tipo.

Os valores deste campo NUMERIC ou BIGNUMERIC têm de estar neste intervalo quando:

  • A precisão (P) e a escala (S) são especificadas: [-10P-S + 10-S, 10P-S - 10-S]
  • A precisão (P) é especificada, mas não a escala (e, por isso, a escala é interpretada como igual a zero): [-10P + 1, 10P - 1].

Valores aceitáveis para a precisão e a escala se ambas forem especificadas:

  • Se type = "NUMERIC": 1 ≤ precision - scale ≤ 29 e 0 ≤ scale ≤ 9.
  • Se o tipo for "BIGNUMERIC": 1 ≤ precisão - escala ≤ 38 e 0 ≤ escala ≤ 38.

Valores aceitáveis para a precisão se apenas a precisão for especificada, mas não a escala (e, por isso, a escala é interpretada como igual a zero):

  • Se type = "NUMERIC": 1 ≤ precisão ≤ 29.
  • Se type = "BIGNUMERIC": 1 ≤ precisão ≤ 38.

Se a escala for especificada, mas a precisão não, é inválido.

scale

string (int64 format)

Opcional. Consulte a documentação para ver a precisão.

timestampPrecision

string (Int64Value format)

Opcional. Precisão (número máximo de dígitos totais na base 10) para segundos do tipo TIMESTAMP.

Os valores possíveis incluem: * 6 (predefinição, para o tipo TIMESTAMP com precisão de microssegundos) * 12 (para o tipo TIMESTAMP com precisão de picossegundos)

roundingMode

enum (RoundingMode)

Opcional. Especifica o modo de arredondamento a usar ao armazenar valores do tipo NUMERIC e BIGNUMERIC.

collation

string

Opcional. A ordenação de campos só pode ser definida quando o tipo de campo é STRING. Os seguintes valores são suportados:

  • 'und:ci': local indeterminado, sem distinção entre maiúsculas e minúsculas.
  • "": string vazia. Comportamento predefinido sensível a maiúsculas e minúsculas.
defaultValueExpression

string

Opcional. Uma expressão SQL para especificar o valor predefinido deste campo.

rangeElementType

object (FieldElementType)

Opcional. O subtipo do INTERVALO, se o tipo deste campo for INTERVALO. Se o tipo for RANGE, este campo é obrigatório. Os valores para o tipo de elemento de campo podem ser os seguintes:

  • DATA
  • DATA/HORA
  • TIMESTAMP
foreignTypeDefinition

string

Opcional. Definição do tipo de dados externo. Válido apenas para campos de esquema de nível superior (não campos aninhados). Se o tipo for FOREIGN, este campo é obrigatório.

Representação JSON
{
  "names": [
    string
  ]
}
Campos
names[]

string

Uma lista de nomes de recursos de etiquetas de políticas. Por exemplo, "projects/1/locations/eu/taxonomies/2/policyTags/3". Atualmente, é permitida, no máximo, 1 etiqueta de política.

Representação JSON
{

  // Union field _name can be only one of the following:
  "name": string
  // End of list of possible types for union field _name.
}
Campos

Campo de união _name.

_name só pode ser uma das seguintes opções:

name

string

Nome do recurso da política de dados no formato projects/project_id/locations/location_id/dataPolicies/data_policy_id.

Representação JSON
{
  "value": string
}
Campos
value

string (int64 format)

O valor int64.

Representação JSON
{
  "type": string
}
Campos
type

string

Obrigatório. O tipo de um elemento de campo. Para mais informações, consulte TableFieldSchema.type.

Representação JSON
{
  "typeSystem": enum (TypeSystem)
}
Campos
typeSystem

enum (TypeSystem)

Obrigatório. Especifica o sistema que define o tipo de dados externos.

Representação JSON
{
  "type": string,
  "expirationMs": string,
  "field": string,
  "requirePartitionFilter": boolean
}
Campos
type

string

Obrigatório. Os tipos suportados são DAY, HOUR, MONTH e YEAR, que geram uma partição por dia, hora, mês e ano, respetivamente.

expirationMs

string (Int64Value format)

Opcional. Número de milissegundos durante os quais o armazenamento de uma partição deve ser mantido. Aqui, é usado um contentor porque 0 é um valor inválido.

field

string

Opcional. Se não estiver definido, a tabela é particionada pela pseudocoluna "_PARTITIONTIME"; se estiver definido, a tabela é particionada por este campo. O campo tem de ser um campo TIMESTAMP ou DATE de nível superior. O respetivo modo tem de ser NULLABLE ou REQUIRED. Aqui, é usado um contentor porque uma string vazia é um valor inválido.

requirePartitionFilter
(deprecated)

boolean

Se for definida como verdadeira, as consultas sobre esta tabela requerem a especificação de um filtro de partição que possa ser usado para a eliminação de partições. Este campo está obsoleto. Em alternativa, defina o campo com o mesmo nome na própria tabela. Este campo precisa de um wrapper porque queremos gerar o valor predefinido, false, se o utilizador o tiver definido explicitamente.

Representação JSON
{
  "value": boolean
}
Campos
value

boolean

O valor bool.

Representação JSON
{
  "field": string,
  "range": {
    object (Range)
  }
}
Campos
field

string

Obrigatório. O nome da coluna na qual a tabela deve ser particionada. Tem de ser uma coluna INT64 de nível superior cujo modo seja NULLABLE ou REQUIRED.

range

object (Range)

Define os intervalos para a partição por intervalo.

Representação JSON
{
  "start": string,
  "end": string,
  "interval": string
}
Campos
start

string

Obrigatório. O início da partição por intervalo, inclusive. Este campo é um valor INT64 representado como uma string.

end

string

Obrigatório. O fim da partição por intervalo, exclusivo. Este campo é um valor INT64 representado como uma string.

interval

string

Obrigatório. A largura de cada intervalo. Este campo é um valor INT64 representado como uma string.

Representação JSON
{
  "fields": [
    string
  ]
}
Campos
fields[]

string

Um ou mais campos nos quais os dados devem ser agrupados. Apenas são suportados campos de nível superior, não repetidos e de tipo simples. A ordem dos campos de agrupamento deve ser dada prioridade do mais para o menos importante para fins de filtragem.

Para mais informações, consulte o artigo Introdução às tabelas agrupadas.

Representação JSON
{
  "partitionedColumn": [
    {
      object (PartitionedColumn)
    }
  ]
}
Campos
partitionedColumn[]

object (PartitionedColumn)

Opcional. Detalhes acerca de cada coluna de particionamento. Este campo é apenas de saída para todos os tipos de partição, exceto para tabelas particionadas do metastore. As tabelas nativas do BigQuery só suportam 1 coluna de particionamento. Outros tipos de tabelas podem suportar 0, 1 ou mais colunas de partição. Para tabelas particionadas do metastore, a ordem tem de corresponder à ordem de definição no Hive Metastore, onde tem de corresponder à disposição física da tabela. Por exemplo,

CREATE TABLE a_table(id BIGINT, name STRING) PARTITIONED BY (city STRING, state STRING).

Neste caso, os valores têm de ser ['city', 'state'] nessa ordem.

Representação JSON
{

  // Union field _field can be only one of the following:
  "field": string
  // End of list of possible types for union field _field.
}
Campos

Campo de união _field.

_field só pode ser uma das seguintes opções:

field

string

Obrigatório. O nome da coluna de partição.

Representação JSON
{
  "value": string
}
Campos
value

string

O valor uint64.

Representação JSON
{
  "query": string,
  "userDefinedFunctionResources": [
    {
      object (UserDefinedFunctionResource)
    }
  ],
  "useLegacySql": boolean,
  "useExplicitColumnNames": boolean,
  "privacyPolicy": {
    object (PrivacyPolicy)
  },
  "foreignDefinitions": [
    {
      object (ForeignViewDefinition)
    }
  ]
}
Campos
query

string

Obrigatório. Uma consulta que o BigQuery executa quando a vista é referenciada.

userDefinedFunctionResources[]

object (UserDefinedFunctionResource)

Descreve os recursos de funções definidas pelo utilizador usados na consulta.

useLegacySql

boolean

Especifica se deve usar o SQL antigo do BigQuery para esta vista. O valor predefinido é True. Se estiver definido como falso, a vista usa o GoogleSQL do BigQuery: https://cloud.google.com/bigquery/sql-reference/

As consultas e as visualizações que fazem referência a esta vista têm de usar o mesmo valor da flag. Aqui, é usado um wrapper porque o valor predefinido é True.

useExplicitColumnNames

boolean

Verdadeiro se os nomes das colunas forem especificados explicitamente. Por exemplo, usando a sintaxe "CREATE VIEW v(c1, c2) AS ...". Só pode ser definido para vistas GoogleSQL.

privacyPolicy

object (PrivacyPolicy)

Opcional. Especifica a política de privacidade da vista.

foreignDefinitions[]

object (ForeignViewDefinition)

Opcional. Representações de vistas estrangeiras.

Representação JSON
{
  "resourceUri": string,
  "inlineCode": string,
  "inlineCodeAlternative": [
    string
  ]
}
Campos
resourceUri

string

[Escolha uma] Um recurso de código a carregar a partir de um URI do Google Cloud Storage (gs://bucket/path).

inlineCode

string

[Escolha uma] Um recurso inline que contém código para uma função definida pelo utilizador (FDU). Fornecer um recurso de código inline é equivalente a fornecer um URI para um ficheiro que contenha o mesmo código.

inlineCodeAlternative[]

string

Representação JSON
{

  // Union field privacy_policy can be only one of the following:
  "aggregationThresholdPolicy": {
    object (AggregationThresholdPolicy)
  },
  "differentialPrivacyPolicy": {
    object (DifferentialPrivacyPolicy)
  }
  // End of list of possible types for union field privacy_policy.

  // Union field _join_restriction_policy can be only one of the following:
  "joinRestrictionPolicy": {
    object (JoinRestrictionPolicy)
  }
  // End of list of possible types for union field _join_restriction_policy.
}
Campos
Campo de união privacy_policy. Política de privacidade associada a esta especificação de requisitos. Só é permitido um dos métodos de privacidade por objeto de origem de dados. privacy_policy só pode ser uma das seguintes opções:
aggregationThresholdPolicy

object (AggregationThresholdPolicy)

Opcional. Política usada para limites de agregação.

differentialPrivacyPolicy

object (DifferentialPrivacyPolicy)

Opcional. Política usada para privacidade diferencial.

Campo de união _join_restriction_policy.

_join_restriction_policy só pode ser uma das seguintes opções:

joinRestrictionPolicy

object (JoinRestrictionPolicy)

Opcional. A política de restrição de participação está fora de uma das políticas, uma vez que esta política pode ser definida juntamente com outras políticas. Esta política dá aos fornecedores de dados a capacidade de aplicar junções nas "join_allowed_columns" quando os dados são consultados a partir de uma vista protegida pela privacidade.

Representação JSON
{
  "privacyUnitColumns": [
    string
  ],

  // Union field _threshold can be only one of the following:
  "threshold": string
  // End of list of possible types for union field _threshold.
}
Campos
privacyUnitColumns[]

string

Opcional. As colunas da unidade de privacidade associadas a esta política. Por agora, só é permitida uma coluna por objeto de origem de dados (tabela, vista) como coluna de unidade de privacidade. Representação como um campo repetido nos metadados para extensibilidade a várias colunas no futuro. Não são permitidos duplicados nem campos de estrutura repetidos. Para campos aninhados, use a notação de pontos ("outer.inner")

Campo de união _threshold.

_threshold só pode ser uma das seguintes opções:

threshold

string (int64 format)

Opcional. O limite da política de "limite da agregação".

Representação JSON
{

  // Union field _max_epsilon_per_query can be only one of the following:
  "maxEpsilonPerQuery": number
  // End of list of possible types for union field _max_epsilon_per_query.

  // Union field _delta_per_query can be only one of the following:
  "deltaPerQuery": number
  // End of list of possible types for union field _delta_per_query.

  // Union field _max_groups_contributed can be only one of the following:
  "maxGroupsContributed": string
  // End of list of possible types for union field _max_groups_contributed.

  // Union field _privacy_unit_column can be only one of the following:
  "privacyUnitColumn": string
  // End of list of possible types for union field _privacy_unit_column.

  // Union field _epsilon_budget can be only one of the following:
  "epsilonBudget": number
  // End of list of possible types for union field _epsilon_budget.

  // Union field _delta_budget can be only one of the following:
  "deltaBudget": number
  // End of list of possible types for union field _delta_budget.

  // Union field _epsilon_budget_remaining can be only one of the following:
  "epsilonBudgetRemaining": number
  // End of list of possible types for union field _epsilon_budget_remaining.

  // Union field _delta_budget_remaining can be only one of the following:
  "deltaBudgetRemaining": number
  // End of list of possible types for union field _delta_budget_remaining.
}
Campos

Campo de união _max_epsilon_per_query.

_max_epsilon_per_query só pode ser uma das seguintes opções:

maxEpsilonPerQuery

number

Opcional. O valor épsilon máximo que uma consulta pode consumir. Se o subscritor especificar o épsilon como um parâmetro numa consulta SELECT, tem de ser inferior ou igual a este valor. O parâmetro epsilon controla a quantidade de ruído que é adicionada aos grupos. Um valor epsilon mais elevado significa menos ruído.

Campo de união _delta_per_query.

_delta_per_query só pode ser uma das seguintes opções:

deltaPerQuery

number

Opcional. O valor delta usado por consulta. Delta representa a probabilidade de qualquer linha não ser diferencialmente privada com épsilon. Indica o risco associado à exposição de linhas agregadas no resultado de uma consulta.

Campo de união _max_groups_contributed.

_max_groups_contributed só pode ser uma das seguintes opções:

maxGroupsContributed

string (int64 format)

Opcional. O valor máximo de grupos contribuídos que é usado por consulta. Representa o número máximo de grupos aos quais cada entidade protegida pode contribuir. A alteração deste valor não melhora nem piora a privacidade. O melhor valor para a precisão e a utilidade depende da consulta e dos dados.

Campo de união _privacy_unit_column.

_privacy_unit_column só pode ser uma das seguintes opções:

privacyUnitColumn

string

Opcional. A coluna da unidade de privacidade associada a esta política. As políticas de privacidade diferencial só podem ter uma coluna de unidade de privacidade por objeto de origem de dados (tabela, vista).

Campo de união _epsilon_budget.

_epsilon_budget só pode ser uma das seguintes opções:

epsilonBudget

number

Opcional. O orçamento de épsilon total para todas as consultas na vista protegida pela privacidade. Cada consulta de subscritor em relação a esta vista cobra o valor de épsilon que o subscritor pede na respetiva consulta. Se existir orçamento suficiente, a consulta do subscritor tenta ser concluída. Ainda pode falhar por outros motivos, caso em que a cobrança é reembolsada. Se não houver orçamento suficiente, a consulta é rejeitada. Podem existir várias tentativas de cobrança se uma única consulta fizer referência a várias visualizações. Neste caso, tem de existir orçamento suficiente para todos os custos, ou a consulta é rejeitada e os custos são reembolsados da melhor forma possível. O orçamento não tem uma política de atualização e só pode ser atualizado através de ALTER VIEW ou contornado com a criação de uma nova visualização que possa ser consultada com um novo orçamento.

Campo de união _delta_budget.

_delta_budget só pode ser uma das seguintes opções:

deltaBudget

number

Opcional. O orçamento delta total para todas as consultas em relação à vista protegida pela privacidade. Cada consulta de subscritor em relação a esta vista cobra o valor da diferença pré-definido pelo contribuinte através do campo delta_per_query da política de privacidade. Se existir orçamento suficiente, a consulta do subscritor tenta ser concluída. Ainda pode falhar por outros motivos, caso em que a cobrança é reembolsada. Se não houver orçamento suficiente, a consulta é rejeitada. Podem existir várias tentativas de cobrança se uma única consulta fizer referência a várias visualizações. Neste caso, tem de existir orçamento suficiente para todos os custos, ou a consulta é rejeitada e os custos são reembolsados da melhor forma possível. O orçamento não tem uma política de atualização e só pode ser atualizado através de ALTER VIEW ou contornado com a criação de uma nova visualização que possa ser consultada com um novo orçamento.

Campo de união _epsilon_budget_remaining.

_epsilon_budget_remaining só pode ser uma das seguintes opções:

epsilonBudgetRemaining

number

Apenas saída. O orçamento epsilon restante. Se o orçamento estiver esgotado, não são permitidas mais consultas. Tenha em atenção que o orçamento das consultas em curso é deduzido antes da execução da consulta. Se a consulta falhar ou for cancelada, o orçamento é reembolsado. Neste caso, o valor do orçamento restante pode aumentar.

Campo de união _delta_budget_remaining.

_delta_budget_remaining só pode ser uma das seguintes opções:

deltaBudgetRemaining

number

Apenas saída. O delta do orçamento restante. Se o orçamento estiver esgotado, não são permitidas mais consultas. Tenha em atenção que o orçamento das consultas em curso é deduzido antes da execução da consulta. Se a consulta falhar ou for cancelada, o orçamento é reembolsado. Neste caso, o valor do orçamento restante pode aumentar.

Representação JSON
{
  "joinAllowedColumns": [
    string
  ],

  // Union field _join_condition can be only one of the following:
  "joinCondition": enum (JoinCondition)
  // End of list of possible types for union field _join_condition.
}
Campos
joinAllowedColumns[]

string

Opcional. As únicas colunas nas quais são permitidas junções. Este campo tem de ser especificado para join_conditions JOIN_ANY e JOIN_ALL, e não pode ser definido para JOIN_BLOCKED.

Campo de união _join_condition.

_join_condition só pode ser uma das seguintes opções:

joinCondition

enum (JoinCondition)

Opcional. Especifica se é necessária ou não uma junção nas consultas para a vista. A predefinição é JOIN_CONDITION_UNSPECIFIED.

Representação JSON
{
  "query": string,
  "dialect": string
}
Campos
query

string

Obrigatório. A consulta que define a vista.

dialect

string

Opcional. Representa o dialeto da consulta.

Representação JSON
{
  "query": string,
  "lastRefreshTime": string,
  "enableRefresh": boolean,
  "refreshIntervalMs": string,
  "allowNonIncrementalDefinition": boolean
}
Campos
query

string

Obrigatório. Uma consulta cujos resultados são mantidos.

lastRefreshTime

string (int64 format)

Apenas saída. A hora em que esta vista materializada foi atualizada pela última vez, em milissegundos desde a época.

enableRefresh

boolean

Opcional. Ative a atualização automática da vista materializada quando a tabela base é atualizada. O valor predefinido é "true".

refreshIntervalMs

string (UInt64Value format)

Opcional. A frequência máxima com que esta vista materializada é atualizada. O valor predefinido é "1800000" (30 minutos).

allowNonIncrementalDefinition

boolean

Opcional. Esta opção declara a intenção de construir uma vista materializada que não é atualizada de forma incremental. As visualizações de propriedades materializadas não incrementais suportam uma gama expandida de consultas SQL. Não é possível alterar a opção allow_non_incremental_definition após a criação da vista materializada.

Representação JSON
{
  "refreshWatermark": string,
  "lastRefreshStatus": {
    object (ErrorProto)
  }
}
Campos
refreshWatermark

string (Timestamp format)

Apenas saída. Atualize a marca de água da vista materializada. Os dados das tabelas de base foram recolhidos na cache da vista materializada até esta altura.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

lastRefreshStatus

object (ErrorProto)

Apenas saída. Resultado do erro da última atualização automática. Se estiver presente, indica que a última atualização automática não foi bem-sucedida.

Representação JSON
{
  "seconds": string,
  "nanos": integer
}
Campos
seconds

string (int64 format)

Representa os segundos da hora UTC desde a época Unix 1970-01-01T00:00:00Z. Tem de estar entre -62135596800 e 253402300799, inclusive (o que corresponde a 0001-01-01T00:00:00Z a 9999-12-31T23:59:59Z).

nanos

integer

Frações não negativas de um segundo com resolução de nanosegundos. Este campo é a parte dos nanosegundos da duração e não uma alternativa aos segundos. Os valores de segundos negativos com frações têm de ter valores de nanos não negativos que contam para a frente no tempo. Tem de ser um valor entre 0 e 999 999 999, inclusive.

Representação JSON
{
  "reason": string,
  "location": string,
  "debugInfo": string,
  "message": string
}
Campos
reason

string

Um código de erro curto que resume o erro.

location

string

Especifica onde ocorreu o erro, se estiver presente.

debugInfo

string

Informações de depuração. Esta propriedade é interna à Google e não deve ser usada.

message

string

Uma descrição legível do erro.

Representação JSON
{
  "sourceUris": [
    string
  ],
  "fileSetSpecType": enum (FileSetSpecType),
  "schema": {
    object (TableSchema)
  },
  "sourceFormat": string,
  "maxBadRecords": integer,
  "autodetect": boolean,
  "ignoreUnknownValues": boolean,
  "compression": string,
  "csvOptions": {
    object (CsvOptions)
  },
  "jsonOptions": {
    object (JsonOptions)
  },
  "bigtableOptions": {
    object (BigtableOptions)
  },
  "googleSheetsOptions": {
    object (GoogleSheetsOptions)
  },
  "maxBadRecordsAlternative": [
    integer
  ],
  "hivePartitioningOptions": {
    object (HivePartitioningOptions)
  },
  "connectionId": string,
  "decimalTargetTypes": [
    enum (DecimalTargetType)
  ],
  "avroOptions": {
    object (AvroOptions)
  },
  "jsonExtension": enum (JsonExtension),
  "parquetOptions": {
    object (ParquetOptions)
  },
  "referenceFileSchemaUri": string,
  "metadataCacheMode": enum (MetadataCacheMode),
  "timestampTargetPrecision": [
    integer
  ],

  // Union field _object_metadata can be only one of the following:
  "objectMetadata": enum (ObjectMetadata)
  // End of list of possible types for union field _object_metadata.

  // Union field _time_zone can be only one of the following:
  "timeZone": string
  // End of list of possible types for union field _time_zone.

  // Union field _date_format can be only one of the following:
  "dateFormat": string
  // End of list of possible types for union field _date_format.

  // Union field _datetime_format can be only one of the following:
  "datetimeFormat": string
  // End of list of possible types for union field _datetime_format.

  // Union field _time_format can be only one of the following:
  "timeFormat": string
  // End of list of possible types for union field _time_format.

  // Union field _timestamp_format can be only one of the following:
  "timestampFormat": string
  // End of list of possible types for union field _timestamp_format.
}
Campos
sourceUris[]

string

[Obrigatório] Os URIs totalmente qualificados que apontam para os seus dados no Google Cloud. Para URIs do Google Cloud Storage: cada URI pode conter um caráter universal "*" e tem de aparecer após o nome do "recipiente". Os limites de tamanho relacionados com tarefas de carregamento aplicam-se a origens de dados externas. Para URIs do Google Cloud Bigtable: pode especificar exatamente um URI, que tem de ser um URL HTTPS totalmente especificado e válido para uma tabela do Google Cloud Bigtable. Para cópias de segurança do Google Cloud Datastore, pode especificar exatamente um URI. Além disso, o caráter universal "*" não é permitido.

fileSetSpecType

enum (FileSetSpecType)

Opcional. Especifica como os URIs de origem são interpretados para construir o conjunto de ficheiros a carregar. Por predefinição, os URIs de origem são expandidos em relação ao armazenamento subjacente. Outras opções incluem a especificação de ficheiros de manifesto. Aplicável apenas a sistemas de armazenamento de objetos.

schema

object (TableSchema)

Opcional. O esquema dos dados. O esquema é obrigatório para os formatos CSV e JSON se a deteção automática não estiver ativada. O esquema não é permitido para os formatos Google Cloud Bigtable, cópias de segurança do Cloud Datastore, Avro, ORC e Parquet.

sourceFormat

string

[Obrigatório] O formato de dados. Para ficheiros CSV, especifique "CSV". Para o Google Sheets, especifique "GOOGLE_SHEETS". Para JSON delimitado por Newline, especifique "NEWLINE_DELIMITED_JSON". Para ficheiros Avro, especifique "AVRO". Para cópias de segurança do Google Cloud Datastore, especifique "DATASTORE_BACKUP". Para tabelas Apache Iceberg, especifique "ICEBERG". Para ficheiros ORC, especifique "ORC". Para ficheiros Parquet, especifique "PARQUET". [Beta] Para o Google Cloud Bigtable, especifique "BIGTABLE".

maxBadRecords

integer

Opcional. O número máximo de registos inválidos que o BigQuery pode ignorar ao ler dados. Se o número de registos inválidos exceder este valor, é devolvido um erro inválido no resultado da tarefa. O valor predefinido é 0, o que requer que todos os registos sejam válidos. Esta definição é ignorada para os formatos Google Cloud Bigtable, cópias de segurança do Google Cloud Datastore, Avro, ORC e Parquet.

autodetect

boolean

Tentar detetar automaticamente o esquema e as opções de formato. Qualquer opção especificada explicitamente é respeitada.

ignoreUnknownValues

boolean

Opcional. Indica se o BigQuery deve permitir valores adicionais que não estão representados no esquema da tabela. Se for verdadeiro, os valores adicionais são ignorados. Se for falso, os registos com colunas adicionais são tratados como registos inválidos e, se existirem demasiados registos inválidos, é devolvido um erro inválido no resultado da tarefa. O valor predefinido é false. A propriedade sourceFormat determina o que o BigQuery trata como um valor adicional: CSV: colunas finais JSON: valores com nome que não correspondem a nenhum nome de coluna Google Cloud Bigtable: esta definição é ignorada. Cópias de segurança do Google Cloud Datastore: esta definição é ignorada. Avro: esta definição é ignorada. ORC: esta definição é ignorada. Parquet: esta definição é ignorada.

compression

string

Opcional. O tipo de compressão da origem de dados. Os valores possíveis incluem GZIP e NONE. O valor predefinido é NONE. Esta definição é ignorada para os formatos Google Cloud Bigtable, cópias de segurança do Google Cloud Datastore, Avro, ORC e Parquet. Uma string vazia é um valor inválido.

csvOptions

object (CsvOptions)

Opcional. Propriedades adicionais a definir se sourceFormat estiver definido como CSV.

jsonOptions

object (JsonOptions)

Opcional. Propriedades adicionais a definir se sourceFormat estiver definido como JSON.

bigtableOptions

object (BigtableOptions)

Opcional. Opções adicionais se sourceFormat estiver definido como BIGTABLE.

googleSheetsOptions

object (GoogleSheetsOptions)

Opcional. Opções adicionais se sourceFormat estiver definido como GOOGLE_SHEETS.

maxBadRecordsAlternative[]

integer

Este campo não deve ser usado.

hivePartitioningOptions

object (HivePartitioningOptions)

Opcional. Quando definida, configura o suporte de partições de Hive. Nem todos os formatos de armazenamento suportam a partição de Hive. Se pedir a partição de Hive num formato não suportado ou fornecer uma especificação inválida, ocorre um erro.

connectionId

string

Opcional. A ligação que especifica as credenciais a usar para ler o armazenamento externo, como o Azure Blob, o Cloud Storage ou o S3. O connection_id pode ter o formato {project_id}.{location_id};{connection_id} ou projects/{project_id}/locations/{location_id}/connections/{connection_id}.

decimalTargetTypes[]

enum (DecimalTargetType)

Define a lista de tipos de dados SQL possíveis para os quais os valores decimais de origem são convertidos. Esta lista e os parâmetros de precisão e escala do campo decimal determinam o tipo de destino. Pela ordem NUMERIC, BIGNUMERIC e STRING, é escolhido um tipo se estiver na lista especificada e se suportar a precisão e a escala. STRING suporta todos os valores de precisão e escala. Se nenhum dos tipos listados suportar a precisão e a escala, é selecionado o tipo que suporta o intervalo mais amplo na lista especificada e, se um valor exceder o intervalo suportado ao ler os dados, é gerado um erro.

Exemplo: suponhamos que o valor deste campo é ["NUMERIC", "BIGNUMERIC"]. Se (precision,scale) for:

  • (38,9) -> NUMERIC;
  • (39,9) -> BIGNUMERIC (NUMERIC não pode conter 30 dígitos inteiros);
  • (38,10) -> BIGNUMERIC (NUMERIC não pode conter 10 dígitos de fração);
  • (76,38) -> BIGNUMERIC;
  • (77,38) -> BIGNUMERIC (erro se o valor exceder o intervalo suportado).

Este campo não pode conter tipos duplicados. A ordem dos tipos neste campo é ignorada. Por exemplo, ["BIGNUMERIC", "NUMERIC"] é o mesmo que ["NUMERIC", "BIGNUMERIC"] e NUMERIC tem sempre precedência sobre BIGNUMERIC.

O valor predefinido é ["NUMERIC", "STRING"] para ORC e ["NUMERIC"] para os outros formatos de ficheiros.

avroOptions

object (AvroOptions)

Opcional. Propriedades adicionais a definir se sourceFormat estiver definido como AVRO.

jsonExtension

enum (JsonExtension)

Opcional. Opção de carregamento a usar juntamente com o JSON delimitado por novas linhas source_format para indicar que está a ser carregada uma variante do JSON. Para carregar GeoJSON delimitado por newline, especifique GEOJSON (e source_format tem de estar definido como NEWLINE_DELIMITED_JSON).

parquetOptions

object (ParquetOptions)

Opcional. Propriedades adicionais a definir se sourceFormat estiver definido como PARQUET.

referenceFileSchemaUri

string

Opcional. Ao criar uma tabela externa, o utilizador pode fornecer um ficheiro de referência com o esquema da tabela. Esta opção está ativada para os seguintes formatos: AVRO, PARQUET e ORC.

metadataCacheMode

enum (MetadataCacheMode)

Opcional. Modo de cache de metadados para a tabela. Defina esta opção para ativar o armazenamento em cache de metadados da origem de dados externa.

timestampTargetPrecision[]

integer

Precisões (número máximo de dígitos totais na base 10) para segundos de tipos TIMESTAMP permitidos na tabela de destino para o modo de deteção automática.

Disponível para os formatos: CSV.

Para o formato CSV, os valores possíveis incluem: Not Specified, [], ou [6]: timestamp(6) para todas as colunas TIMESTAMP detetadas automaticamente [6, 12]: timestamp(6) para todas as colunas TIMESTAMP detetadas automaticamente que tenham menos de 6 dígitos de subsegundos. timestamp(12) para todas as colunas TIMESTAMP detetadas automaticamente que tenham mais de 6 dígitos de subsegundos. [12]: timestamp(12) para todas as colunas TIMESTAMP detetadas automaticamente.

A ordem dos elementos nesta matriz é ignorada. As entradas com uma precisão superior à precisão do alvo mais elevado nesta matriz são truncadas.

Campo de união _object_metadata.

_object_metadata só pode ser uma das seguintes opções:

objectMetadata

enum (ObjectMetadata)

Opcional. ObjectMetadata é usado para criar tabelas de objetos. As tabelas de objetos contêm uma lista de objetos (com os respetivos metadados) encontrados nos source_uris. Se ObjectMetadata estiver definido, source_format deve ser omitido.

Atualmente, SIMPLE é o único tipo de metadados de objetos suportado.

Campo de união _time_zone.

_time_zone só pode ser uma das seguintes opções:

timeZone

string

Opcional. Fuso horário usado ao analisar valores de data/hora que não têm informações de fuso horário específicas (por exemplo, 2024-04-20 12:34:56). O formato esperado é uma string de fuso horário da IANA (por exemplo, America/Los_Angeles).

Campo de união _date_format.

_date_format só pode ser uma das seguintes opções:

dateFormat

string

Opcional. Formato usado para analisar valores DATE. Suporta valores de estilo C e estilo SQL.

Campo de união _datetime_format.

_datetime_format só pode ser uma das seguintes opções:

datetimeFormat

string

Opcional. Formato usado para analisar valores DATETIME. Suporta valores de estilo C e estilo SQL.

Campo de união _time_format.

_time_format só pode ser uma das seguintes opções:

timeFormat

string

Opcional. Formato usado para analisar valores TIME. Suporta valores de estilo C e estilo SQL.

Campo de união _timestamp_format.

_timestamp_format só pode ser uma das seguintes opções:

timestampFormat

string

Opcional. Formato usado para analisar valores de DATA/HORA. Suporta valores de estilo C e estilo SQL.

Representação JSON
{
  "value": integer
}
Campos
value

integer

O valor int32.

Representação JSON
{
  "fieldDelimiter": string,
  "skipLeadingRows": string,
  "quote": string,
  "allowQuotedNewlines": boolean,
  "allowJaggedRows": boolean,
  "encoding": string,
  "preserveAsciiControlCharacters": boolean,
  "nullMarker": string,
  "nullMarkers": [
    string
  ],
  "sourceColumnMatch": string
}
Campos
fieldDelimiter

string

Opcional. O caráter separador dos campos num ficheiro CSV. O separador é interpretado como um único byte. Para ficheiros codificados em ISO-8859-1, é possível usar qualquer caráter único como separador. Para ficheiros codificados em UTF-8, os carateres representados no intervalo decimal 1-127 (U+0001-U+007F) podem ser usados sem modificações. Os carateres UTF-8 codificados com vários bytes (ou seja, U+0080 e superior) só têm o primeiro byte usado para separar campos. Os bytes restantes são tratados como parte do campo. O BigQuery também suporta a sequência de escape "\t" (U+0009) para especificar um separador de tabulação. O valor predefinido é uma vírgula (",", U+002C).

skipLeadingRows

string (Int64Value format)

Opcional. O número de linhas na parte superior de um ficheiro CSV que o BigQuery vai ignorar ao ler os dados. O valor predefinido é 0. Esta propriedade é útil se tiver linhas de cabeçalho no ficheiro que devem ser ignoradas. Quando a deteção automática está ativada, o comportamento é o seguinte:

  • skipLeadingRows não especificado: a deteção automática tenta detetar cabeçalhos na primeira linha. Se não forem detetados, a linha é lida como dados. Caso contrário, os dados são lidos a partir da segunda linha.
  • skipLeadingRows é 0: indica à deteção automática que não existem cabeçalhos e que os dados devem ser lidos a partir da primeira linha.
  • skipLeadingRows = N > 0: a deteção automática ignora N-1 linhas e tenta detetar cabeçalhos na linha N. Se os cabeçalhos não forem detetados, a linha N é simplesmente ignorada. Caso contrário, a linha N é usada para extrair os nomes das colunas do esquema detetado.
quote

string

Opcional. O valor usado para colocar secções de dados entre aspas num ficheiro CSV. O BigQuery converte a string na codificação ISO-8859-1 e, em seguida, usa o primeiro byte da string codificada para dividir os dados no respetivo estado binário não processado. O valor predefinido é uma aspa dupla ("). Se os seus dados não contiverem secções entre aspas, defina o valor da propriedade como uma string vazia. Se os seus dados contiverem carateres de nova linha entre aspas, também tem de definir a propriedade allowQuotedNewlines como verdadeira. Para incluir o caráter de aspas específico num valor entre aspas, preceda-o de um caráter de aspas correspondente adicional. Por exemplo, se quiser escapar ao caráter predefinido " " ", use " "" ".

allowQuotedNewlines

boolean

Opcional. Indica se o BigQuery deve permitir secções de dados entre aspas que contenham carateres de nova linha num ficheiro CSV. O valor predefinido é false.

allowJaggedRows

boolean

Opcional. Indica se o BigQuery deve aceitar linhas que não tenham colunas opcionais finais. Se for verdadeiro, o BigQuery trata as colunas finais em falta como valores nulos. Se for falso, os registos com colunas finais em falta são tratados como registos inválidos e, se existirem demasiados registos inválidos, é devolvido um erro inválido no resultado da tarefa. O valor predefinido é false.

encoding

string

Opcional. A codificação de carateres dos dados. Os valores suportados são UTF-8, ISO-8859-1, UTF-16BE, UTF-16LE, UTF-32BE e UTF-32LE. O valor predefinido é UTF-8. O BigQuery descodifica os dados depois de os dados binários não processados terem sido divididos através dos valores das propriedades quote e fieldDelimiter.

preserveAsciiControlCharacters

boolean

Opcional. Indica se os carateres de controlo ASCII incorporados (os primeiros 32 carateres na tabela ASCII, de "\x00" a "\x1F") são preservados.

nullMarker

string

Opcional. Especifica uma string que representa um valor nulo num ficheiro CSV. Por exemplo, se especificar "\N", o BigQuery interpreta "\N" como um valor nulo quando consulta um ficheiro CSV. O valor predefinido é a string vazia. Se definir esta propriedade para um valor personalizado, o BigQuery gera um erro se estiver presente uma string vazia para todos os tipos de dados, exceto STRING e BYTE. Para colunas STRING e BYTE, o BigQuery interpreta a string vazia como um valor vazio.

nullMarkers[]

string

Opcional. Uma lista de strings representada como valor NULL de SQL num ficheiro CSV.

Não é possível definir null_marker e null_markers em simultâneo. Se null_marker estiver definido, null_markers não pode estar definido. Se null_markers estiver definido, null_marker não pode estar definido. Se null_marker e null_markers forem definidos ao mesmo tempo, é apresentado um erro do utilizador. Todas as strings listadas em null_markers, incluindo a string vazia, seriam interpretadas como SQL NULL. Isto aplica-se a todos os tipos de colunas.

sourceColumnMatch

string

Opcional. Controla a estratégia usada para fazer corresponder as colunas carregadas ao esquema. Se não for definido, é escolhida uma predefinição sensata com base na forma como o esquema é fornecido. Se for usada a deteção automática, as colunas são associadas por nome. Caso contrário, as colunas são associadas por posição. Isto é feito para manter o comportamento retrocompatível. Os valores aceitáveis são: POSITION: corresponde por posição. Isto pressupõe que as colunas estão ordenadas da mesma forma que o esquema. NAME: corresponde por nome. Isto lê a linha de cabeçalho como nomes de colunas e reordena as colunas para corresponderem aos nomes dos campos no esquema.

Representação JSON
{
  "encoding": string
}
Campos
encoding

string

Opcional. A codificação de carateres dos dados. Os valores suportados são UTF-8, UTF-16BE, UTF-16LE, UTF-32BE e UTF-32LE. O valor predefinido é UTF-8.

Representação JSON
{
  "columnFamilies": [
    {
      object (BigtableColumnFamily)
    }
  ],
  "ignoreUnspecifiedColumnFamilies": boolean,
  "readRowkeyAsString": boolean,
  "outputColumnFamiliesAsJson": boolean
}
Campos
columnFamilies[]

object (BigtableColumnFamily)

Opcional. Lista de famílias de colunas a expor no esquema da tabela, juntamente com os respetivos tipos. Esta lista restringe as famílias de colunas que podem ser referenciadas em consultas e especifica os respetivos tipos de valores. Pode usar esta lista para fazer conversões de tipos. Consulte o campo "tipo" para ver mais detalhes. Se deixar esta lista vazia, todas as famílias de colunas estão presentes no esquema da tabela e os respetivos valores são lidos como BYTES. Durante uma consulta, apenas as famílias de colunas referenciadas nessa consulta são lidas do Bigtable.

ignoreUnspecifiedColumnFamilies

boolean

Opcional. Se o campo for verdadeiro, as famílias de colunas que não estão especificadas na lista columnFamilies não são expostas no esquema da tabela. Caso contrário, são lidos com valores do tipo BYTES. O valor predefinido é false.

readRowkeyAsString

boolean

Opcional. Se o campo for verdadeiro, as famílias de colunas rowkey são lidas e convertidas em string. Caso contrário, são lidos com valores do tipo BYTES e os utilizadores têm de os converter manualmente com CAST, se necessário. O valor predefinido é false.

outputColumnFamiliesAsJson

boolean

Opcional. Se o campo for verdadeiro, cada família de colunas é lida como uma única coluna JSON. Caso contrário, são lidos como uma estrutura de células repetida que contém tuplos de data/hora/valor. O valor predefinido é false.

Representação JSON
{
  "familyId": string,
  "type": string,
  "encoding": string,
  "columns": [
    {
      object (BigtableColumn)
    }
  ],
  "onlyReadLatest": boolean,
  "protoConfig": {
    object (BigtableProtoConfig)
  }
}
Campos
familyId

string

Identificador da família de colunas.

type

string

Opcional. O tipo para converter o valor nas células desta família de colunas. Os valores devem ser codificados através da função Bytes.toBytes do HBase quando usar o valor de codificação BINARY. Os seguintes tipos do BigQuery são permitidos (com distinção entre maiúsculas e minúsculas):

  • BYTES
  • STRING
  • INTEGER
  • FLOAT
  • BOOLEAN
  • JSON

O tipo predefinido é BYTES. Isto pode ser substituído para uma coluna específica listando essa coluna em "columns" e especificando um tipo para a mesma.

encoding

string

Opcional. A codificação dos valores quando o tipo não é STRING. Os valores de codificação aceitáveis são: TEXT: indica que os valores são strings de texto alfanuméricas. BINARY: indica que os valores são codificados através da família de funções HBase Bytes.toBytes. PROTO_BINARY: indica que os valores são codificados através de mensagens proto serializadas. Só pode ser usado em combinação com o tipo JSON. Isto pode ser substituído para uma coluna específica ao listar essa coluna em "columns" e especificar uma codificação para a mesma.

columns[]

object (BigtableColumn)

Opcional. Listas de colunas que devem ser expostas como campos individuais, em vez de uma lista de pares (nome da coluna, valor). Pode aceder a todas as colunas cujo qualificador corresponda a um qualificador nesta lista como <family field name>.<column field name>. Pode aceder a outras colunas como uma lista através do campo <family field name>.Column.

onlyReadLatest

boolean

Opcional. Se esta opção estiver definida, apenas a versão mais recente do valor é exposta para todas as colunas nesta família de colunas. Isto pode ser substituído para uma coluna específica ao listar essa coluna em "columns" e especificar uma definição diferente para essa coluna.

protoConfig

object (BigtableProtoConfig)

Opcional. As configurações específicas do Protobuf só têm efeito quando a codificação é PROTO_BINARY.

Representação JSON
{
  "qualifierEncoded": string,
  "qualifierString": string,
  "fieldName": string,
  "type": string,
  "encoding": string,
  "onlyReadLatest": boolean,
  "protoConfig": {
    object (BigtableProtoConfig)
  }
}
Campos
qualifierEncoded

string (BytesValue format)

[Obrigatório] Qualificador da coluna. As colunas na família de colunas principal que têm este qualificador exato são expostas como o campo <family field name>.<column field name>. Se o qualificador for uma string UTF-8 válida, pode ser especificado no campo qualifier_string. Caso contrário, tem de definir um valor codificado em base64 para qualifier_encoded. O nome do campo da coluna é igual ao qualificador da coluna. No entanto, se o qualificador não for um identificador de campo do BigQuery válido, ou seja, não corresponder a [a-zA-Z][a-zA-Z0-9_]*, tem de ser fornecido um identificador válido como field_name.

qualifierString

string

String de qualificação.

fieldName

string

Opcional. Se o qualificador não for um identificador de campo do BigQuery válido, ou seja, não corresponder a [a-zA-Z][a-zA-Z0-9_]*, tem de ser fornecido um identificador válido como nome do campo da coluna, que é usado como nome do campo nas consultas.

type

string

Opcional. O tipo para converter o valor nas células desta coluna. Os valores devem ser codificados através da função Bytes.toBytes do HBase quando usar o valor de codificação BINARY. Os seguintes tipos do BigQuery são permitidos (com distinção entre maiúsculas e minúsculas):

  • BYTES
  • STRING
  • INTEGER
  • FLOAT
  • BOOLEAN
  • JSON

O tipo predefinido é BYTES. "type" também pode ser definido ao nível da família de colunas. No entanto, a definição a este nível tem precedência se o "tipo" estiver definido em ambos os níveis.

encoding

string

Opcional. A codificação dos valores quando o tipo não é STRING. Os valores de codificação aceitáveis são: TEXT: indica que os valores são strings de texto alfanuméricas. BINARY: indica que os valores são codificados através da família de funções HBase Bytes.toBytes. PROTO_BINARY: indica que os valores são codificados através de mensagens proto serializadas. Só pode ser usado em combinação com o tipo JSON. Também é possível definir a "codificação" ao nível da família de colunas. No entanto, a definição a este nível tem prioridade se a "codificação" estiver definida em ambos os níveis.

onlyReadLatest

boolean

Opcional. Se esta opção estiver definida, apenas é exposta a versão mais recente do valor nesta coluna. Também é possível definir "onlyReadLatest" ao nível da família de colunas. No entanto, a definição a este nível tem precedência se "onlyReadLatest" estiver definida a ambos os níveis.

protoConfig

object (BigtableProtoConfig)

Opcional. As configurações específicas do Protobuf só têm efeito quando a codificação é PROTO_BINARY.

Representação JSON
{
  "value": string
}
Campos
value

string (bytes format)

O valor de bytes.

Uma string codificada em Base64.

Representação JSON
{
  "schemaBundleId": string,
  "protoMessageName": string
}
Campos
schemaBundleId

string

Opcional. O ID do recurso Bigtable SchemaBundle associado a este protobuf. O ID deve ser referenciado na tabela principal, por exemplo: foo em vez de projects/{project}/instances/{instance}/tables/{table}/schemaBundles/foo. Veja mais detalhes sobre os SchemaBundles do Bigtable.

protoMessageName

string

Opcional. O nome da mensagem proto totalmente qualificado do protobuf. No formato "foo.bar.Message".

Representação JSON
{
  "skipLeadingRows": string,
  "range": string
}
Campos
skipLeadingRows

string (Int64Value format)

Opcional. O número de linhas na parte superior de uma página que o BigQuery ignora ao ler os dados. O valor predefinido é 0. Esta propriedade é útil se tiver linhas de cabeçalho que devem ser ignoradas. Quando a deteção automática está ativada, o comportamento é o seguinte: * skipLeadingRows não especificado: a deteção automática tenta detetar cabeçalhos na primeira linha. Se não forem detetados, a linha é lida como dados. Caso contrário, os dados são lidos a partir da segunda linha. * skipLeadingRows é 0: indica à deteção automática que não existem cabeçalhos e que os dados devem ser lidos a partir da primeira linha. * skipLeadingRows = N > 0 - A deteção automática ignora N-1 linhas e tenta detetar cabeçalhos na linha N. Se os cabeçalhos não forem detetados, a linha N é simplesmente ignorada. Caso contrário, a linha N é usada para extrair os nomes das colunas do esquema detetado.

range

string

Opcional. Intervalo de uma página a partir do qual se vai consultar. Usado apenas quando não está vazio. Formato típico: nome_página!id_célula_superior_esquerda:id_célula_inferior_direita. Por exemplo: Página1!A1:B20

Representação JSON
{
  "mode": string,
  "sourceUriPrefix": string,
  "requirePartitionFilter": boolean,
  "fields": [
    string
  ]
}
Campos
mode

string

Opcional. Quando definido, que modo de particionamento de colmeias usar ao ler dados. São suportados os seguintes modos:

  • AUTO: deduz automaticamente os nomes e os tipos das chaves de partição.

  • STRINGS: infere automaticamente os nomes das chaves de partição. Todos os tipos são strings.

  • CUSTOM: o esquema da chave de partição está codificado no prefixo do URI de origem.

Nem todos os formatos de armazenamento suportam a partição de Hive. Pedir a partição de Hive num formato não suportado vai gerar um erro. Atualmente, os formatos suportados são: JSON, CSV, ORC, Avro e Parquet.

sourceUriPrefix

string

Opcional. Quando a deteção de partições do Hive é pedida, é necessário um prefixo comum para todos os URIs de origem. O prefixo tem de terminar imediatamente antes do início da codificação da chave de partição. Por exemplo, considere ficheiros que seguem este esquema de dados:

gs://bucket/path_to_table/dt=2019-06-01/country=USA/id=7/file.avro

gs://bucket/path_to_table/dt=2019-05-31/country=CA/id=3/file.avro

Quando a partição de Hive é pedida com a deteção AUTO ou STRINGS, o prefixo comum pode ser gs://bucket/path_to_table ou gs://bucket/path_to_table/.

A deteção CUSTOM requer a codificação do esquema de partição imediatamente após o prefixo comum. Para o tipo CUSTOM, qualquer de

  • gs://bucket/path_to_table/{dt:DATE}/{country:STRING}/{id:INTEGER}

  • gs://bucket/path_to_table/{dt:STRING}/{country:STRING}/{id:INTEGER}

  • gs://bucket/path_to_table/{dt:DATE}/{country:STRING}/{id:STRING}

seriam todos prefixos de URI de origem válidos.

requirePartitionFilter

boolean

Opcional. Se for definida como verdadeira, as consultas sobre esta tabela requerem a especificação de um filtro de partição que possa ser usado para a eliminação de partições.

Tenha em atenção que este campo só deve ser verdadeiro quando criar uma tabela externa permanente ou consultar uma tabela externa temporária.

Os carregamentos particionados do Hive com require_partition_filter definido explicitamente como verdadeiro falham.

fields[]

string

Apenas saída. Para tabelas externas permanentes, este campo é preenchido com as chaves de partição do Hive pela ordem em que foram inferidas. Os tipos das chaves de partição podem ser deduzidos verificando o esquema da tabela (que inclui as chaves de partição). Nem todas as APIs preenchem este campo na saída. Por exemplo, Tables.Get preenche-o, mas Tables.List não contém este campo.

Representação JSON
{
  "useAvroLogicalTypes": boolean
}
Campos
useAvroLogicalTypes

boolean

Opcional. Se sourceFormat estiver definido como "AVRO", indica se os tipos lógicos devem ser interpretados como o tipo de dados do BigQuery correspondente (por exemplo, TIMESTAMP), em vez de usar o tipo não processado (por exemplo, INTEGER).

Representação JSON
{
  "enumAsString": boolean,
  "enableListInference": boolean,
  "mapTargetType": enum (MapTargetType)
}
Campos
enumAsString

boolean

Opcional. Indica se deve inferir o tipo lógico ENUM Parquet como STRING em vez de BYTES por predefinição.

enableListInference

boolean

Opcional. Indica se deve usar a inferência de esquemas especificamente para o tipo lógico LIST Parquet.

mapTargetType

enum (MapTargetType)

Opcional. Indica como representar um mapa Parquet, se estiver presente.

Representação JSON
{
  "connectionId": string,
  "storageUri": string,
  "fileFormat": enum (FileFormat),
  "tableFormat": enum (TableFormat)
}
Campos
connectionId

string

Opcional. A ligação que especifica as credenciais a usar para ler e escrever no armazenamento externo, como o Cloud Storage. O connection_id pode ter o formato {project}.{location}.{connection_id} ou "projects/{project}/locations/{location}/connections/{connection_id}".

storageUri

string

Opcional. O prefixo de localização totalmente qualificado da pasta externa onde os dados da tabela estão armazenados. O caráter universal "*" não é permitido. O URI deve estar no formato gs://bucket/path_to_table/

fileFormat

enum (FileFormat)

Opcional. O formato de ficheiro no qual os dados da tabela estão armazenados.

tableFormat

enum (TableFormat)

Opcional. O formato de tabela no qual os resumos apenas de metadados são armazenados.

Representação JSON
{
  "estimatedBytes": string,
  "estimatedRows": string,
  "oldestEntryTime": string
}
Campos
estimatedBytes

string

Apenas saída. Uma estimativa do limite inferior do número de bytes atualmente no buffer de streaming.

estimatedRows

string

Apenas saída. Uma estimativa do limite inferior do número de linhas atualmente no buffer de streaming.

oldestEntryTime

string (uint64 format)

Apenas saída. Contém a data/hora da entrada mais antiga na memória intermédia de streaming, em milissegundos desde a época, se a memória intermédia de streaming estiver disponível.

Representação JSON
{
  "kmsKeyName": string
}
Campos
kmsKeyName

string

Opcional. Descreve a chave de encriptação do Cloud KMS que vai ser usada para proteger a tabela do BigQuery de destino. A conta de serviço do BigQuery associada ao seu projeto requer acesso a esta chave de encriptação.

Representação JSON
{
  "baseTableReference": {
    object (TableReference)
  },
  "snapshotTime": string
}
Campos
baseTableReference

object (TableReference)

Obrigatório. Referência que descreve o ID da tabela da qual foi tirada uma captura instantânea.

snapshotTime

string (Timestamp format)

Obrigatório. A hora em que a tabela de base foi capturada. Este valor é comunicado na resposta JSON através do formato RFC3339.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

Representação JSON
{
  "baseTableReference": {
    object (TableReference)
  },
  "cloneTime": string
}
Campos
baseTableReference

object (TableReference)

Obrigatório. Referência que descreve o ID da tabela que foi clonada.

cloneTime

string (Timestamp format)

Obrigatório. A hora em que a tabela base foi clonada. Este valor é comunicado na resposta JSON através do formato RFC3339.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

Representação JSON
{
  "type": enum (RestrictionType)
}
Campos
type

enum (RestrictionType)

Apenas saída. Especifica o tipo de restrição de conjunto de dados/tabela.

Representação JSON
{
  "primaryKey": {
    object (PrimaryKey)
  },
  "foreignKeys": [
    {
      object (ForeignKey)
    }
  ]
}
Campos
primaryKey

object (PrimaryKey)

Opcional. Representa uma restrição de chave principal nas colunas de uma tabela. Presente apenas se a tabela tiver uma chave principal. A chave principal não é aplicada.

foreignKeys[]

object (ForeignKey)

Opcional. Presente apenas se a tabela tiver uma chave externa. A chave externa não é aplicada.

Representação JSON
{
  "columns": [
    string
  ]
}
Campos
columns[]

string

Obrigatório. As colunas que são compostas pela restrição de chave principal.

Representação JSON
{
  "name": string,
  "referencedTable": {
    object (TableReference)
  },
  "columnReferences": [
    {
      object (ColumnReference)
    }
  ]
}
Campos
name

string

Opcional. Definido apenas se a restrição de chave externa tiver um nome.

referencedTable

object (TableReference)

Obrigatório. A tabela que contém a chave principal e é referenciada por esta chave externa.

columnReferences[]

object (ColumnReference)

Obrigatório. As colunas que compõem a chave externa.

Representação JSON
{
  "referencingColumn": string,
  "referencedColumn": string
}
Campos
referencingColumn

string

Obrigatório. A coluna que compõe a chave externa.

referencedColumn

string

Obrigatório. A coluna na chave principal que é referenciada por referencing_column.

Representação JSON
{
  "key": string,
  "value": string
}
Campos
key

string

value

string

Representação JSON
{
  "sourceTable": {
    object (TableReference)
  },
  "replicationIntervalMs": string,
  "replicatedSourceLastRefreshTime": string,
  "replicationStatus": enum (ReplicationStatus),
  "replicationError": {
    object (ErrorProto)
  }
}
Campos
sourceTable

object (TableReference)

Obrigatório. Referência da tabela de origem replicada.

replicationIntervalMs

string (int64 format)

Opcional. Especifica o intervalo no qual a tabela de origem é consultada para atualizações. É opcional. Se não for especificado, é aplicado o intervalo de replicação predefinido.

replicatedSourceLastRefreshTime

string (int64 format)

Opcional. Apenas saída. Se a origem for uma vista materializada, este campo indica a hora da última atualização da origem.

replicationStatus

enum (ReplicationStatus)

Opcional. Apenas saída. Estado da replicação da replicação configurada.

replicationError

object (ErrorProto)

Opcional. Apenas saída. Erro de replicação que vai interromper permanentemente a replicação da tabela.

Representação JSON
{
  "parameters": {
    string: string,
    ...
  },
  "storageDescriptor": {
    object (StorageDescriptor)
  },
  "connectionId": string
}
Campos
parameters

map (key: string, value: string)

Opcional. Um mapa dos pares de chave-valor que definem os parâmetros e as propriedades da tabela de código aberto. Corresponde aos parâmetros da tabela do metastore do Hive. Tamanho máximo de 4 MiB.

Um objeto que contém uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

storageDescriptor

object (StorageDescriptor)

Opcional. Um descritor de armazenamento que contém informações sobre o armazenamento físico desta tabela.

connectionId

string

Opcional. Um ID de associação que especifica as credenciais a usar para ler o armazenamento externo, como o Azure Blob, o Cloud Storage ou o Amazon S3. Esta associação é necessária para ler a tabela de código aberto do BigQuery. O formato de connection_id tem de ser <project_id>.<location_id>.<connection_id> ou projects/<project_id>/locations/<location_id>/connections/<connection_id>.

Representação JSON
{
  "key": string,
  "value": string
}
Campos
key

string

value

string

Representação JSON
{
  "locationUri": string,
  "inputFormat": string,
  "outputFormat": string,
  "serdeInfo": {
    object (SerDeInfo)
  }
}
Campos
locationUri

string

Opcional. A localização física da tabela (por exemplo, gs://spark-dataproc-data/pangea-data/case_sensitive/ ou gs://spark-dataproc-data/pangea-data/*). O comprimento máximo é de 2056 bytes.

inputFormat

string

Opcional. Especifica o nome da classe totalmente qualificado do InputFormat (por exemplo, "org.apache.hadoop.hive.ql.io.orc.OrcInputFormat"). O comprimento máximo é de 128 carateres.

outputFormat

string

Opcional. Especifica o nome de classe totalmente qualificado do OutputFormat (por exemplo, "org.apache.hadoop.hive.ql.io.orc.OrcOutputFormat"). O comprimento máximo é de 128 carateres.

serdeInfo

object (SerDeInfo)

Opcional. Informações do serializador e desserializador.

Representação JSON
{
  "name": string,
  "serializationLibrary": string,
  "parameters": {
    string: string,
    ...
  }
}
Campos
name

string

Opcional. Nome do SerDe. O comprimento máximo é de 256 carateres.

serializationLibrary

string

Obrigatório. Especifica um nome de classe totalmente qualificado da biblioteca de serialização responsável pela tradução de dados entre a representação da tabela e as estruturas de formato de entrada e saída de baixo nível subjacentes. O comprimento máximo é de 256 carateres.

parameters

map (key: string, value: string)

Opcional. Pares de chave-valor que definem os parâmetros de inicialização para a biblioteca de serialização. Tamanho máximo: 10 KiB.

Um objeto que contém uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Representação JSON
{
  "key": string,
  "value": string
}
Campos
key

string

value

string

Anotações de ferramentas

Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌