MCP Tools Reference: bigquery.googleapis.com

Ferramenta: get_table_info

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

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

Solicitação 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

Solicitação de uma tabela.

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

string

Obrigatório. ID do projeto da solicitação de tabela.

datasetId

string

Obrigatório. ID do conjunto de dados da solicitação de tabela.

tableId

string

Obrigatório. ID da tabela da solicitação.

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 de 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 acessar esse recurso novamente.

tableReference

object (TableReference)

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

friendlyName

string

Opcional. Um nome descritivo para a tabela.

description

string

Opcional. Uma descrição amigável desta tabela.

labels

map (key: string, value: string)

Os rótulos associados a esta tabela. Você pode usá-los para organizar e agrupar suas tabelas. As chaves e os valores de rótulo não podem ter mais de 63 caracteres e só podem conter letras minúsculas, caracteres numéricos, sublinhados e traços. Caracteres internacionais são permitidos. Os valores de rótulo são opcionais. As chaves de rótulo precisam começar com uma letra, e cada rótulo na lista precisa ter uma chave diferente.

Um objeto com 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 especificado, configura o particionamento baseado em tempo para essa tabela.

rangePartitioning

object (RangePartitioning)

Se especificado, configura o particionamento por intervalo para essa tabela.

clustering

object (Clustering)

Especificação de clustering para a tabela. Precisa ser especificado com o particionamento baseado em tempo. Os dados na tabela serão particionados e, em seguida, agrupados.

requirePartitionFilter

boolean

Opcional. Se definido como "true", as consultas nessa tabela exigem um filtro de partição que possa ser usado para especificar a eliminação de partições.

numBytes

string (Int64Value format)

Apenas saída. O tamanho dessa tabela em bytes lógicos, excluindo os dados no buffer de streaming.

numPhysicalBytes

string (Int64Value format)

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

numLongTermBytes

string (Int64Value format)

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

numRows

string (UInt64Value format)

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

creationTime

string (int64 format)

Apenas saída. A hora em que esta tabela foi criada, em milissegundos, desde o Unix epoch.

expirationTime

string (Int64Value format)

Opcional. O momento em que esta tabela expira, em milissegundos desde a época. Se ausente, a tabela persistirá indefinidamente. Tabelas expiradas serão excluídas, e seu espaço reaproveitado. A propriedade defaultTableExpirationMs do conjunto de dados encapsulado pode ser usada para definir um expirationTime padrão em tabelas recém-criadas.

lastModifiedTime

string (uint64 format)

Apenas saída. O horário em que a tabela foi modificada pela última vez, em milissegundos desde o período.

type

string

Apenas saída. Descreve o tipo de tabela. Os valores a seguir são compatíveis:

  • 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 em um sistema de armazenamento externo, como o Google Cloud Storage.
  • MATERIALIZED_VIEW: uma visualização pré-calculada definida por uma consulta SQL.
  • SNAPSHOT: uma tabela imutável do BigQuery que preserva o conteúdo de uma tabela base em um determinado momento. Consulte mais informações sobre snapshots de tabelas.

O valor padrão é TABLE.

view

object (ViewDefinition)

Opcional. A definição da visualização.

materializedView

object (MaterializedViewDefinition)

Opcional. A definição da visualização materializada.

materializedViewStatus

object (MaterializedViewStatus)

Apenas saída. O status da visualização materializada.

externalDataConfiguration

object (ExternalDataConfiguration)

Opcional. Descreve o formato de dados, o local e outras propriedades de uma tabela armazenada fora do BigQuery. Ao definir essas propriedades, a fonte de dados pode ser consultada como se fosse uma tabela do BigQuery padrão.

biglakeConfiguration

object (BigLakeConfiguration)

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

managedTableType

enum (ManagedTableType)

Opcional. Se definido, substitui o tipo de tabela gerenciada padrão configurado no conjunto de dados.

location

string

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

streamingBuffer

object (Streamingbuffer)

Apenas saída. Contém informações sobre o buffer de streaming da tabela, se houver. Esse campo não vai aparecer se a tabela não estiver sendo transmitida ou se não houver dados no buffer de streaming.

encryptionConfiguration

object (EncryptionConfiguration)

Configuração de criptografia personalizada (por exemplo, chaves do Cloud KMS).

snapshotDefinition

object (SnapshotDefinition)

Apenas saída. Contém informações sobre o snapshot. Esse valor é definido na criação do instantâneo.

defaultCollation

string

Opcional. Define a especificação de ordenação padrão de novos campos STRING na tabela. Durante a criação ou atualização da tabela, se um campo STRING for adicionado a ela sem uma ordenação explícita, a tabela vai herdar a ordenação padrão. Uma mudança nesse campo afeta apenas os campos adicionados depois e não altera os campos atuais. Os valores a seguir são compatíveis:

  • 'und:ci': localidade indeterminada, sem diferenciação de maiúsculas e minúsculas.
  • '': string vazia. O padrão é diferenciar maiúsculas de minúsculas.
defaultRoundingMode

enum (RoundingMode)

Opcional. Define a especificação do modo de arredondamento padrão de novos campos decimais (NUMERIC ou BIGNUMERIC) na tabela. Durante a criação ou atualização da tabela, se um campo decimal for adicionado a ela sem um modo de arredondamento explícito especificado, o campo vai herdar o modo de arredondamento padrão da tabela. Mudar esse campo não afeta os campos atuais.

cloneDefinition

object (CloneDefinition)

Apenas saída. Contém informações sobre o clone. Esse valor é definido pela 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 excluídos ou alterados). Esses dados não são mantidos em tempo real e podem atrasar de alguns segundos a alguns minutos.

numTotalLogicalBytes

string (Int64Value format)

Apenas saída. Número total de bytes lógicos na tabela ou visualização 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 ativos atual. Esses dados não são mantidos em tempo real e podem atrasar de alguns segundos a alguns minutos.

numTotalPhysicalBytes

string (Int64Value format)

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

numActivePhysicalBytes

string (Int64Value format)

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

numLongTermPhysicalBytes

string (Int64Value format)

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

numPartitions

string (Int64Value format)

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

maxStaleness

string

Opcional. A desatualização máxima dos dados que podem ser retornados quando a tabela (ou MV desatualizada) é consultada. Inatividade codificada como uma string do tipo IntervalValue do SQL.

restrictions

object (RestrictionConfig)

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

tableConstraints

object (TableConstraints)

Opcional. Informações de chave primária e externa das tabelas

resourceTags

map (key: string, value: string)

Opcional. As tags anexadas a esta tabela. As chaves de tag são exclusivas em todo o mundo. A chave de tag precisa estar no formato com namespace, por exemplo, "123456789012/environment", em que 123456789012 é o ID da organização ou do recurso de projeto pai dessa chave de tag. O valor da tag precisa ser o nome abreviado, por exemplo, "Production". Consulte Definições de tags para mais detalhes.

Um objeto com 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 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 tabela de todas as réplicas ativas no momento.

externalCatalogTableOptions

object (ExternalCatalogTableOptions)

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

Campo de união _partition_definition.

_partition_definition pode ser apenas de um dos tipos a seguir:

partitionDefinition

object (PartitioningDefinition)

Opcional. As informações de partição para todos os formatos de tabela, incluindo tabelas particionadas gerenciadas, tabelas particionadas do Hive, tabelas particionadas do Iceberg e tabelas particionadas do metastore. Esse campo só é preenchido para tabelas particionadas da metastore. Para outros formatos de tabela, esse é um campo somente 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 a tabela.

datasetId

string

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

tableId

string

Obrigatório. O ID da tabela. O ID pode conter caracteres Unicode nas categorias L (letra), M (marca), N (número), Pc (conector, incluindo sublinhado), Pd (travessão) e Zs (espaço). Para mais informações, consulte Categoria geral. O comprimento máximo é de 1.024 caracteres. Algumas operações permitem adicionar um sufixo ao ID da tabela com um decorador de partição, 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 da 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 na tabela.

foreignTypeInfo

object (ForeignTypeInfo)

Opcional. Especifica metadados da definição do tipo de dados externo no esquema de campo (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. Nome do campo. O nome precisa conter apenas letras (a-z, A-Z), números (0-9) ou sublinhados (_) e começar com uma letra ou sublinhado. O tamanho máximo é de 300 caracteres.

type

string

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

  • STRING
  • BYTES
  • INTEGER (ou INT64)
  • FLOAT (ou FLOAT64)
  • BOOLEAN (ou BOOL)
  • TIMESTAMP
  • DATE
  • TIME
  • DATETIME
  • GEOGRAPHY
  • NUMERIC
  • BIGNUMERIC
  • JSON
  • RECORD (ou STRUCT)
  • RANGE

O uso de RECORD/STRUCT indica que o campo contém um esquema aninhado.

mode

string

Opcional. O modo do campo. Os valores possíveis incluem NULLABLE, REQUIRED e REPEATED. O valor padrão é NULLABLE.

fields[]

object (TableFieldSchema)

Opcional. Descreve os campos de esquema aninhados se a propriedade "type" estiver definida como "RECORD".

description

string

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

policyTags

object (PolicyTagList)

Opcional. As tags de política anexadas a esse campo, usadas para controle de acesso no nível do campo. Se não for definido, o padrão será "policy_tags" vazio.

dataPolicies[]

object (DataPolicyOption)

Opcional. Políticas de dados anexadas a este campo, usadas para controle de acesso no 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, nenhuma restrição de tamanho máximo será imposta a esse campo.

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

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

Não é possível definir esse 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 desse campo para NUMERIC ou BIGNUMERIC.

Não é possível definir precisão ou escala se o tipo não for "NUMERIC" nem "BIGNUMERIC".

Se a precisão e a escala não forem especificadas, nenhuma restrição de intervalo de valores será imposta a esse campo, desde que os valores sejam permitidos pelo tipo.

Os valores desse campo NUMERIC ou BIGNUMERIC precisam estar nesse intervalo quando:

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

Valores aceitáveis para precisão e escala, se ambos forem especificados:

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

Valores aceitáveis para precisão se apenas a precisão for especificada, mas não a escala (e, portanto, a escala for 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 não a precisão, ela será inválida.

scale

string (int64 format)

Opcional. Consulte a documentação para saber mais sobre 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 (padrã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 ser usado 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 valores a seguir são compatíveis:

  • 'und:ci': localidade indeterminada, sem diferenciação de maiúsculas e minúsculas.
  • '': string vazia. O padrão é diferenciar maiúsculas de minúsculas.
defaultValueExpression

string

Opcional. Uma expressão SQL para especificar o valor padrão desse campo.

rangeElementType

object (FieldElementType)

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

  • DATE
  • DATETIME
  • TIMESTAMP
foreignTypeDefinition

string

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

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

string

Uma lista de nomes de recursos de tag de política. Por exemplo, "projects/1/locations/eu/taxonomies/2/policyTags/3". No momento, é permitida apenas uma tag 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 pode ser apenas de um dos tipos a seguir:

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. Veja mais informações em TableFieldSchema.type.

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

enum (TypeSystem)

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

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

string

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

expirationMs

string (Int64Value format)

Opcional. Número de milissegundos em que o armazenamento de uma partição será mantido. Um wrapper é usado aqui porque 0 é um valor inválido.

field

string

Opcional. Se não for definido, a tabela será particionada pela pseudocoluna "_PARTITIONTIME". Se for definido, a tabela será particionada por esse campo. O campo precisa ser um CARIMBO DE DATA/HORA ou DATA de nível superior. O modo precisa ser NULLABLE ou REQUIRED. Um wrapper é usado aqui porque uma string vazia é um valor inválido.

requirePartitionFilter
(deprecated)

boolean

Se definido como "true", as consultas nessa tabela exigem um filtro de partição que possa ser usado para especificar a eliminação de partições. Esse campo está descontinuado. Em vez disso, defina o campo com o mesmo nome na própria tabela. Esse campo precisa de um wrapper porque queremos gerar o valor padrão "false" se o usuário o definir explicitamente.

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

boolean

O valor booleano.

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

string

Obrigatório. O nome da coluna em que a tabela será particionada. Ela precisa ser uma coluna INT64 de nível superior com modo NULLABLE ou REQUIRED.

range

object (Range)

Define os intervalos para o particionamento por intervalo.

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

string

Obrigatório. O início do particionamento de intervalo, inclusivo. Esse campo é um valor INT64 representado como uma string.

end

string

Obrigatório. O fim do particionamento de intervalo, exclusivo. Esse campo é um valor INT64 representado como uma string.

interval

string

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

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

string

Um ou mais campos em que os dados devem ser agrupados. Somente campos de nível superior, não repetidos e de tipo simples são aceitos. A ordenação dos campos de clusterização deve ser priorizada do mais importante para o menos importante para fins de filtragem.

Para mais informações, consulte Introdução às tabelas em cluster.

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

object (PartitionedColumn)

Opcional. Detalhes sobre cada coluna de particionamento. Esse campo é somente de saída para todos os tipos de particionamento, exceto tabelas particionadas por metastore. As tabelas nativas do BigQuery são compatíveis com apenas uma coluna de particionamento. Outros tipos de tabela podem aceitar 0, 1 ou mais colunas de particionamento. Para tabelas particionadas do metastore, a ordem precisa corresponder à ordem de definição no metastore do Hive, que precisa corresponder ao layout físico da tabela. Por exemplo,

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

Nesse caso, os valores precisam 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 pode ser apenas de um dos tipos a seguir:

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 visualização é referenciada.

userDefinedFunctionResources[]

object (UserDefinedFunctionResource)

Descreve os recursos de função definida pelo usuário usados na consulta.

useLegacySql

boolean

Especifica se o SQL legado do BigQuery será usado para essa visualização. O valor padrão é true. Se definido como "false", a visualização vai usar o GoogleSQL do BigQuery: https://cloud.google.com/bigquery/sql-reference/

As consultas e visualizações que fazem referência a essa visualização precisam usar o mesmo valor de flag. Um wrapper é usado aqui porque o valor padrão é "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 visualizações do GoogleSQL.

privacyPolicy

object (PrivacyPolicy)

Opcional. Especifica a Política de Privacidade da visualização.

foreignDefinitions[]

object (ForeignViewDefinition)

Opcional. Representações de visualizações estrangeiras.

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

string

[Escolha uma opção] Um recurso de código para carregar de um URI do Cloud Storage (gs://bucket/path).

inlineCode

string

[Escolha uma opção] Um recurso in-line que contém o código de uma função definida pelo usuário (UDF). Fornecer um recurso de código in-line é equivalente a fornecer um URI para um arquivo que contém 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 requisito. Só é permitido um dos métodos de privacidade por objeto de fonte de dados. privacy_policy pode ser apenas de um dos tipos a seguir:
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 pode ser apenas de um dos tipos a seguir:

joinRestrictionPolicy

object (JoinRestrictionPolicy)

Opcional. A política de restrição de mesclagem está fora de uma das políticas, já que ela pode ser definida com outras políticas. Essa política permite que os provedores de dados apliquem junções nas "join_allowed_columns" quando os dados são consultados de uma visualização protegida por 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 de unidade de privacidade associadas a essa política. Por enquanto, apenas uma coluna por objeto de fonte de dados (tabela, visualização) é permitida como uma coluna de unidade de privacidade. Representado como um campo repetido em metadados para extensibilidade a várias colunas no futuro. Não é permitido duplicar campos de struct nem usar campos repetidos. Para campos aninhados, use a notação de ponto ("externo.interno")

Campo de união _threshold.

_threshold pode ser apenas de um dos tipos a seguir:

threshold

string (int64 format)

Opcional. O limite da política de "limite de 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 pode ser apenas de um dos tipos a seguir:

maxEpsilonPerQuery

number

Opcional. O valor máximo de épsilon que uma consulta pode consumir. Se o assinante especificar epsilon como um parâmetro em uma consulta SELECT, ele precisará ser menor ou igual a esse valor. O parâmetro épsilon controla a quantidade de ruído adicionada aos grupos. Um épsilon maior significa menos ruído.

Campo de união _delta_per_query.

_delta_per_query pode ser apenas de um dos tipos a seguir:

deltaPerQuery

number

Opcional. O valor delta usado por consulta. Delta representa a probabilidade de que qualquer linha não seja um épsilon privado diferencial. Indica o risco associado à exposição de linhas agregadas no resultado de uma consulta.

Campo de união _max_groups_contributed.

_max_groups_contributed pode ser apenas de um dos tipos a seguir:

maxGroupsContributed

string (int64 format)

Opcional. O valor máximo de grupos contribuídos usado por consulta. Representa o número máximo de grupos com que cada entidade protegida pode contribuir. Mudar esse valor não melhora nem piora a privacidade. O melhor valor para acurácia e utilidade depende da consulta e dos dados.

Campo de união _privacy_unit_column.

_privacy_unit_column pode ser apenas de um dos tipos a seguir:

privacyUnitColumn

string

Opcional. A coluna de unidade de privacidade associada a essa política. As políticas de privacidade diferencial só podem ter uma coluna de unidade de privacidade por objeto de fonte de dados (tabela, visualização).

Campo de união _epsilon_budget.

_epsilon_budget pode ser apenas de um dos tipos a seguir:

epsilonBudget

number

Opcional. O orçamento total de épsilon para todas as consultas na visualização protegida pela privacidade. Cada consulta de assinante nessa visualização cobra o valor de epsilon solicitado na consulta. Se houver orçamento suficiente, a consulta de assinante vai tentar ser concluída. Ela ainda pode falhar por outros motivos, e nesse caso, a cobrança é reembolsada. Se o orçamento for insuficiente, a consulta será rejeitada. Pode haver várias tentativas de cobrança se uma única consulta fizer referência a várias visualizações. Nesse caso, é necessário ter orçamento suficiente para todas as cobranças. Caso contrário, a consulta será rejeitada e as cobranças serão reembolsadas da melhor forma possível. O orçamento não tem uma política de atualização e só pode ser atualizado usando ALTER VIEW ou contornado com a criação de uma nova visualização que pode ser consultada com um orçamento atualizado.

Campo de união _delta_budget.

_delta_budget pode ser apenas de um dos tipos a seguir:

deltaBudget

number

Opcional. O orçamento delta total para todas as consultas na visualização protegida contra violação de privacidade. Cada consulta de assinante nessa visualização cobra o valor de delta predefinido pelo colaborador no campo delta_per_query da Política de Privacidade. Se houver orçamento suficiente, a consulta de assinante vai tentar ser concluída. Ela ainda pode falhar por outros motivos, e nesse caso, a cobrança é reembolsada. Se o orçamento for insuficiente, a consulta será rejeitada. Pode haver várias tentativas de cobrança se uma única consulta fizer referência a várias visualizações. Nesse caso, é necessário ter orçamento suficiente para todas as cobranças. Caso contrário, a consulta será rejeitada e as cobranças serão reembolsadas da melhor forma possível. O orçamento não tem uma política de atualização e só pode ser atualizado usando ALTER VIEW ou contornado com a criação de uma nova visualização que pode ser consultada com um orçamento atualizado.

Campo de união _epsilon_budget_remaining.

_epsilon_budget_remaining pode ser apenas de um dos tipos a seguir:

epsilonBudgetRemaining

number

Apenas saída. O orçamento de epsilon restante. Se o orçamento for esgotado, não serão permitidas mais consultas. O orçamento das consultas em andamento é deduzido antes da execução. Se a consulta falhar ou for cancelada, o orçamento será reembolsado. Nesse caso, o valor restante do orçamento pode aumentar.

Campo de união _delta_budget_remaining.

_delta_budget_remaining pode ser apenas de um dos tipos a seguir:

deltaBudgetRemaining

number

Apenas saída. O orçamento delta restante. Se o orçamento for esgotado, não serão permitidas mais consultas. O orçamento das consultas em andamento é deduzido antes da execução. Se a consulta falhar ou for cancelada, o orçamento será reembolsado. Nesse caso, o valor restante do orçamento 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 em que as junções são permitidas. Esse campo precisa ser especificado para JOIN_ANY e JOIN_ALL em join_conditions, mas não pode ser definido para JOIN_BLOCKED.

Campo de união _join_condition.

_join_condition pode ser apenas de um dos tipos a seguir:

joinCondition

enum (JoinCondition)

Opcional. Especifica se uma junção é necessária ou não em consultas para a visualização. O padrão é JOIN_CONDITION_UNSPECIFIED.

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

string

Obrigatório. A consulta que define a visualização.

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 persistidos.

lastRefreshTime

string (int64 format)

Apenas saída. A hora em que essa visualização materializada foi atualizada pela última vez, em milissegundos desde o início.

enableRefresh

boolean

Opcional. Ative a atualização automática da visualização materializada quando a tabela de base for atualizada. O valor padrão é "true".

refreshIntervalMs

string (UInt64Value format)

Opcional. A frequência máxima com que essa visualização materializada será atualizada. O valor padrão é "1800000" (30 minutos).

allowNonIncrementalDefinition

boolean

Opcional. Essa opção declara a intenção de construir uma visualização materializada que não é atualizada de forma incremental. As visualizações materializadas não incrementais são compatíveis com um intervalo maior de consultas SQL. A opção allow_non_incremental_definition não pode ser alterada depois que a visualização materializada é criada.

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

string (Timestamp format)

Apenas saída. Marca-d'água de atualização da visualização materializada. Os dados das tabelas de base foram coletados no cache de visualização materializada até esse momento.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. 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 presente, indica que a última atualização automática falhou.

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

string (int64 format)

Representa os segundos do horário UTC desde a época Unix 1970-01-01T00:00:00Z. Precisa estar entre -62135596800 e 253402300799 (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 nanossegundos. Esse campo é a parte de nanossegundos da duração, não uma alternativa aos segundos. Os valores de segundos negativos com frações ainda precisam ter valores em nanossegundos não negativos que representam períodos posteriores. O valor precisa estar entre 0 e 999.999.999 (inclusive).

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

string

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

location

string

Especifica onde ocorreu o erro, se presente.

debugInfo

string

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

message

string

Uma descrição legível por humanos 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 seus dados no Google Cloud. Para URIs do Google Cloud Storage: cada URI pode conter um caractere curinga "*" que precisa estar depois do nome do "bucket". Os limites de tamanho relacionados a jobs de carregamento se aplicam a fontes de dados externas. Para URIs do Google Cloud Bigtable: é possível especificar exatamente um URI, que precisa ser um URL HTTPS válido e totalmente especificado para uma tabela do Google Cloud Bigtable. Para backups do Google Cloud Datastore, é possível especificar exatamente um URI. Além disso, o caractere curinga "*" não é permitido.

fileSetSpecType

enum (FileSetSpecType)

Opcional. Especifica como os URIs de origem são interpretados para construir o conjunto de arquivos a ser carregado. Por padrão, os URIs de origem são expandidos no armazenamento subjacente. Outras opções incluem especificar arquivos de manifesto. Aplicável somente a sistemas de armazenamento de objetos.

schema

object (TableSchema)

Opcional. O esquema dos dados. O esquema é necessário para os formatos CSV e JSON se a detecção automática não estiver ativada. O esquema não é permitido para o Google Cloud Bigtable, backups do Cloud Datastore e formatos Avro, ORC e Parquet.

sourceFormat

string

[Obrigatório] O formato de dados. Para arquivos CSV, especifique "CSV". Para as Planilhas Google, especifique "GOOGLE_SHEETS". Para JSON delimitado por nova linha, especifique "NEWLINE_DELIMITED_JSON". Para arquivos Avro, especifique "AVRO". Para backups do Google Cloud Datastore, especifique "DATASTORE_BACKUP". Para tabelas do Apache Iceberg, especifique "ICEBERG". Para arquivos ORC, especifique "ORC". Para arquivos Parquet, especifique "PARQUET". [Beta] Para o Google Cloud Bigtable, especifique "BIGTABLE".

maxBadRecords

integer

Opcional. O número máximo de registros inválidos que o BigQuery pode ignorar ao ler dados. Se o número exceder esse valor, um erro inválido será retornado no resultado do job. O valor padrão é 0, o que exige que todos os registros sejam válidos. Essa configuração é ignorada para backups do Google Cloud Bigtable, do Google Cloud Datastore e formatos Avro, ORC e Parquet.

autodetect

boolean

Tentar detectar automaticamente o esquema e as opções de formatação. Qualquer opção especificada explicitamente será respeitada.

ignoreUnknownValues

boolean

Opcional. Indica se o BigQuery permite outros valores que não estão representados no esquema da tabela. Se for verdadeiro, os outros valores serão ignorados. Se for falso, os registros com colunas extras serão tratados como corrompidos e, se houver muitos desses registros, um erro inválido será retornado no resultado do job. O valor padrão é falso. A propriedade sourceFormat determina o que o BigQuery trata como um valor extra: CSV: colunas à direita. JSON: valores nomeados que não correspondem a nenhum nome de coluna. Google Cloud Bigtable: essa configuração é ignorada. Backups do Google Cloud Datastore: essa configuração é ignorada. Avro: essa configuração é ignorada. ORC: essa configuração é ignorada. Parquet: essa configuração é ignorada.

compression

string

Opcional. O tipo de compactação da fonte de dados. Os valores possíveis incluem GZIP e NONE. O valor padrão é "NONE". Essa configuração é ignorada para backups do Google Cloud Bigtable, do Google Cloud Datastore e formatos Avro, ORC e Parquet. Uma string vazia é um valor inválido.

csvOptions

object (CsvOptions)

Opcional. Outras propriedades a serem definidas se "sourceFormat" for definido como CSV.

jsonOptions

object (JsonOptions)

Opcional. Outras propriedades a serem definidas se "sourceFormat" for 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 definido, configura a compatibilidade com o particionamento do Hive. Nem todos os formatos de armazenamento são compatíveis com o particionamento do Hive. Solicitar o particionamento do Hive em um formato incompatível ou fornecer uma especificação inválida vai gerar um erro.

connectionId

string

Opcional. A conexão que especifica as credenciais a serem usadas para ler o armazenamento externo, como Azure Blob, Cloud Storage ou 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 possíveis tipos de dados SQL em que os valores decimais de origem são convertidos. Essa lista e os parâmetros de precisão e escala do campo decimal determinam o tipo de destino. Na ordem de NUMERIC, BIGNUMERIC e STRING, um tipo será escolhido se estiver na lista especificada e se for compatível com a precisão e a escala. STRING é compatível com todos os valores de precisão e escala. Se nenhum dos tipos listados for compatível com a precisão e a escala, será escolhido o tipo que aceita o intervalo mais amplo na lista especificada. Se um valor exceder o intervalo compatível durante a leitura dos dados, um erro será gerado.

Exemplo: suponha que o valor desse campo seja ["NUMERIC", "BIGNUMERIC"]. Se (precisão,escala) 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 fracionários);
  • (76,38) -> BIGNUMERIC;
  • (77,38) -> BIGNUMERIC (erro se o valor exceder o intervalo compatível).

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

O padrão é ["NUMERIC", "STRING"] para ORC e ["NUMERIC"] para os outros formatos de arquivo.

avroOptions

object (AvroOptions)

Opcional. Outras propriedades a serem definidas se "sourceFormat" for AVRO.

jsonExtension

enum (JsonExtension)

Opcional. Opção de carregamento a ser usada com o JSON delimitado por nova linha source_format para indicar que uma variante do JSON está sendo carregada. Para carregar GeoJSON delimitado por nova linha, especifique GEOJSON (e source_format precisa ser definido como NEWLINE_DELIMITED_JSON).

parquetOptions

object (ParquetOptions)

Opcional. Outras propriedades a serem definidas se "sourceFormat" for definido como "PARQUET".

referenceFileSchemaUri

string

Opcional. Ao criar uma tabela externa, o usuário pode fornecer um arquivo de referência com o esquema da tabela. Isso está ativado para os seguintes formatos: AVRO, PARQUET e ORC.

metadataCacheMode

enum (MetadataCacheMode)

Opcional. Modo de cache de metadados para a tabela. Defina isso para ativar o armazenamento em cache de metadados de uma fonte 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 detecçã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 detectadas automaticamente [6, 12]: timestamp(6) para todas as colunas TIMESTAMP detectadas automaticamente que têm menos de 6 dígitos de microssegundos. timestamp(12) para todas as colunas de carimbo de data/hora detectadas automaticamente que têm mais de seis dígitos de microssegundos. [12]: timestamp(12) para todas as colunas TIMESTAMP detectadas automaticamente.

A ordem dos elementos nessa matriz é ignorada. As entradas com precisão maior que a precisão máxima desejada nessa matriz serão truncadas.

Campo de união _object_metadata.

_object_metadata pode ser apenas de um dos tipos a seguir:

objectMetadata

enum (ObjectMetadata)

Opcional. ObjectMetadata é usado para criar tabelas de objetos. As tabelas de objetos contêm uma lista de objetos (com os metadados deles) encontrados em "source_uris". Se "ObjectMetadata" estiver definido, "source_format" deverá ser omitido.

No momento, SIMPLE é o único tipo de metadados de objeto compatível.

Campo de união _time_zone.

_time_zone pode ser apenas de um dos tipos a seguir:

timeZone

string

Opcional. Fuso horário usado ao analisar valores de carimbo de data/hora que não têm informações específicas de fuso horário (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 pode ser apenas de um dos tipos a seguir:

dateFormat

string

Opcional. Formato usado para analisar valores de data. Aceita valores no estilo C e SQL.

Campo de união _datetime_format.

_datetime_format pode ser apenas de um dos tipos a seguir:

datetimeFormat

string

Opcional. Formato usado para analisar valores de data e hora. Aceita valores no estilo C e SQL.

Campo de união _time_format.

_time_format pode ser apenas de um dos tipos a seguir:

timeFormat

string

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

Campo de união _timestamp_format.

_timestamp_format pode ser apenas de um dos tipos a seguir:

timestampFormat

string

Opcional. Formato usado para analisar valores de CARIMBO DE DATA/HORA. Aceita valores no estilo C e 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 caractere separador de campos em um arquivo CSV. O separador é interpretado como um único byte. Para arquivos codificados em ISO-8859-1, qualquer caractere único pode ser usado como separador. Para arquivos codificados em UTF-8, os caracteres representados no intervalo decimal de 1 a 127 (U+0001 a U+007F) podem ser usados sem modificação. Os caracteres UTF-8 codificados com vários bytes (ou seja, U+0080 e acima) terão apenas o primeiro byte usado para separar campos. Os bytes restantes serão tratados como parte do campo. O BigQuery também aceita a sequência de escape "\t" (U+0009) para especificar um separador de tabulação. O valor padrão é vírgula (",", U+002C).

skipLeadingRows

string (Int64Value format)

Opcional. O número de linhas na parte superior de um arquivo CSV que o BigQuery vai ignorar ao ler os dados. O valor padrão é 0. Essa propriedade é útil se você tiver linhas de cabeçalho no arquivo que precisam ser ignoradas. Quando a detecção automática está ativada, o comportamento é o seguinte:

  • skipLeadingRows não especificado: a detecção automática tenta detectar cabeçalhos na primeira linha. Se não forem detectados, a linha será lida como dados. Caso contrário, os dados serão lidos a partir da segunda linha.
  • skipLeadingRows é 0: instrui a detecção automática de que não há cabeçalhos e que os dados devem ser lidos a partir da primeira linha.
  • skipLeadingRows = N > 0: a detecção automática pula N-1 linhas e tenta detectar cabeçalhos na linha N. Se os cabeçalhos não forem detectados, a linha N será ignorada. Caso contrário, a linha N será usada para extrair nomes de colunas do esquema detectado.
quote

string

Opcional. O valor usado para citar seções de dados em um arquivo CSV. O BigQuery converte a string para a codificação ISO-8859-1 e usa o primeiro byte dela para dividir os dados em estado bruto binário. O valor padrão são aspas duplas ("). Se os dados não tiverem seções com citação direta, defina o valor da propriedade como uma string vazia. Se os dados contiverem caracteres de nova linha com citação direta, defina a propriedade "allowQuotedNewlines" como "true". Para incluir o caractere de citação específico dentro de um valor com citação direta, coloque um caractere extra antes dele. Por exemplo, se quiser inserir o caractere padrão ", use "".

allowQuotedNewlines

boolean

Opcional. Indica se o BigQuery deve permitir seções de dados com citação direta que contêm caracteres de nova linha em um arquivo CSV. O valor padrão é falso.

allowJaggedRows

boolean

Opcional. Indica se o BigQuery aceita linhas que não têm colunas opcionais posteriores. Se for "true", o BigQuery vai tratar as colunas finais ausentes como valores nulos. Se for falso, os registros sem colunas posteriores serão tratados como corrompidos e, se houver muitos desses registros, será retornado um erro inválido no resultado do job. O valor padrão é falso.

encoding

string

Opcional. A codificação de caracteres dos dados. Os valores compatíveis são UTF-8, ISO-8859-1, UTF-16BE, UTF-16LE, UTF-32BE e UTF-32LE. O valor padrão é UTF-8. O BigQuery decodifica os dados depois que os dados binários brutos são divididos usando os valores das propriedades "quote" e "fieldDelimiter".

preserveAsciiControlCharacters

boolean

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

nullMarker

string

Opcional. Especifica uma string que representa um valor nulo em um arquivo CSV. Por exemplo, se você especificar "\N", o BigQuery o interpretará como um valor nulo ao consultar um arquivo CSV. O valor padrão é a string vazia. Se você definir um valor personalizado, o BigQuery vai gerar um erro se uma string vazia estiver presente para todos os tipos de dados, exceto STRING e BYTE. Nessas colunas, o BigQuery interpreta a string vazia como um valor vazio.

nullMarkers[]

string

Opcional. Uma lista de strings representadas como valor NULL do SQL em um arquivo CSV.

null_marker e null_markers não podem ser definidos ao mesmo tempo. Se "null_marker" estiver definido, "null_markers" não poderá ser definido. Se "null_markers" estiver definido, "null_marker" não poderá ser definido. Se null_marker e null_markers forem definidos ao mesmo tempo, um erro do usuário será gerado. Todas as strings listadas em "null_markers", incluindo a string vazia, serão interpretadas como NULL do SQL. Isso se aplica a todos os tipos de coluna.

sourceColumnMatch

string

Opcional. Controla a estratégia usada para corresponder as colunas carregadas ao esquema. Se não for definido, um padrão adequado será escolhido com base em como o esquema é fornecido. Se a detecção automática for usada, as colunas serão correspondidas por nome. Caso contrário, as colunas serão correspondidas por posição. Isso é feito para manter o comportamento compatível com versões anteriores. Os valores aceitáveis são: POSITION, que corresponde por posição. Isso pressupõe que as colunas estejam ordenadas da mesma forma que o esquema. NAME: corresponde por nome. Isso lê a linha de cabeçalho como nomes de colunas e reordena as colunas para corresponder aos nomes dos campos no esquema.

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

string

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

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

object (BigtableColumnFamily)

Opcional. Lista de grupos de colunas a serem expostos no esquema da tabela, juntamente com os tipos deles. Essa lista restringe os grupos de colunas que podem ser referenciados nas consultas e especifica os respectivos tipos de valor. Use essa lista para fazer conversões de tipo. Consulte o campo "tipo" para mais detalhes. Se você deixar essa lista vazia, todas as famílias de colunas estarão presentes no esquema da tabela e os valores delas serão lidos como BYTES. Durante uma consulta, apenas os grupos de colunas referenciados nela são lidos do Bigtable.

ignoreUnspecifiedColumnFamilies

boolean

Opcional. Se o campo for "true", as famílias de colunas não especificadas na lista "columnFamilies" não serão expostas no esquema da tabela. Caso contrário, eles serão lidos com valores do tipo BYTES. O valor padrão é falso.

readRowkeyAsString

boolean

Opcional. Se o campo for "true", os grupos de colunas de rowkey serão lidos e convertidos em string. Caso contrário, eles serão lidos com valores do tipo BYTES, e os usuários precisarão fazer a conversão manualmente com CAST, se necessário. O valor padrão é falso.

outputColumnFamiliesAsJson

boolean

Opcional. Se o campo for verdadeiro, cada grupo de colunas será lido como uma única coluna JSON. Caso contrário, eles serão lidos como uma estrutura de célula repetida que contém tuplas de carimbo de data/hora/valor. O valor padrão é falso.

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

string

Identificador do grupo de colunas.

type

string

Opcional. O tipo para converter o valor nas células desse grupo de colunas. Os valores precisam ser codificados usando a função Bytes.toBytes do HBase ao usar o valor de codificação BINARY. Os seguintes tipos do BigQuery são permitidos (diferencia maiúsculas de minúsculas):

  • BYTES
  • STRING
  • INTEGER
  • FLOAT
  • BOOLEANO
  • JSON

O tipo padrão é BYTES. Isso pode ser substituído para uma coluna específica listando-a em "columns" e especificando um tipo para ela.

encoding

string

Opcional. A codificação dos valores quando o tipo não é STRING. Os valores de codificação aceitáveis são: TEXT, que indica que os valores são strings de texto alfanuméricas. BINARY: indica que os valores são codificados usando a família de funções Bytes.toBytes do HBase. PROTO_BINARY: indica que os valores são codificados usando mensagens proto serializadas. Isso só pode ser usado em combinação com o tipo JSON. Isso pode ser substituído para uma coluna específica listando-a em "columns" e especificando uma codificação para ela.

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). Todas as colunas cujo qualificador corresponda a um qualificador nesta lista podem ser acessadas como <family field name>.<column field name>. Outras colunas podem ser acessadas como uma lista pelo campo <family field name>.Column.

onlyReadLatest

boolean

Opcional. Se essa opção estiver definida, apenas a versão mais recente do valor será exposta para todas as colunas desse grupo de colunas. Isso pode ser substituído para uma coluna específica listando-a em "columns" e especificando uma configuração diferente para ela.

protoConfig

object (BigtableProtoConfig)

Opcional. Configurações específicas do Protobuf, que só entram em vigor 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 no grupo de colunas principal que têm esse qualificador exato são expostas como o campo <family field name>.<column field name>. Se o qualificador for uma string UTF-8 válida, ele poderá ser especificado no campo "qualifier_string". Caso contrário, um valor codificado em base64 precisa ser definido como "qualifier_encoded". O nome do campo da coluna é igual ao qualificador de coluna. No entanto, se o qualificador não for um identificador de campo válido do BigQuery, ou seja, não corresponder a [a-zA-Z][a-zA-Z0-9_]*, um identificador válido precisa ser fornecido como field_name.

qualifierString

string

String do qualificador.

fieldName

string

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

type

string

Opcional. O tipo para converter o valor nas células dessa coluna. Os valores precisam ser codificados usando a função Bytes.toBytes do HBase ao usar o valor de codificação BINARY. Os seguintes tipos do BigQuery são permitidos (diferencia maiúsculas de minúsculas):

  • BYTES
  • STRING
  • INTEGER
  • FLOAT
  • BOOLEANO
  • JSON

O tipo padrão é BYTES. "type" também pode ser definido no nível do grupo de colunas. No entanto, a configuração nesse nível tem precedência se "type" estiver definido nos dois 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, que indica que os valores são strings de texto alfanuméricas. BINARY: indica que os valores são codificados usando a família de funções Bytes.toBytes do HBase. PROTO_BINARY: indica que os valores são codificados usando mensagens proto serializadas. Isso só pode ser usado em combinação com o tipo JSON. "encoding" também pode ser definido no nível do grupo de colunas. No entanto, a configuração nesse nível tem precedência se "encoding" estiver definido nos dois níveis.

onlyReadLatest

boolean

Opcional. Se essa opção estiver definida, apenas a versão mais recente do valor nessa coluna será exposta. "onlyReadLatest" também pode ser definido no nível do grupo de colunas. No entanto, a configuração nesse nível tem precedência se "onlyReadLatest" estiver definido nos dois níveis.

protoConfig

object (BigtableProtoConfig)

Opcional. Configurações específicas do Protobuf, que só entram em vigor 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 precisa ser referenciado na tabela principal, por exemplo, foo em vez de projects/{project}/instances/{instance}/tables/{table}/schemaBundles/foo. Confira mais detalhes sobre os SchemaBundles do Bigtable.

protoMessageName

string

Opcional. O nome totalmente qualificado da mensagem proto 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 planilha que o BigQuery vai ignorar ao ler os dados. O valor padrão é 0. Essa propriedade é útil se você tiver linhas de cabeçalho que precisam ser ignoradas. Quando a detecção automática está ativada, o comportamento é o seguinte: * skipLeadingRows não especificado: a detecção automática tenta detectar cabeçalhos na primeira linha. Se não forem detectados, a linha será lida como dados. Caso contrário, os dados serão lidos a partir da segunda linha. * skipLeadingRows é 0: instrui a detecção automática de que não há cabeçalhos e que os dados devem ser lidos a partir da primeira linha. * skipLeadingRows = N > 0: a detecção automática ignora N-1 linhas e tenta detectar cabeçalhos na linha N. Se os cabeçalhos não forem detectados, a linha N será ignorada. Caso contrário, a linha N será usada para extrair nomes de colunas do esquema detectado.

range

string

Opcional. Intervalo de uma página a ser consultada. Usado somente quando não está vazio. Formato típico: nome_da_planilha!ID_da_célula_superior_esquerda:ID_da_célula_inferior_direita. Por exemplo: planilha1!A1:B20

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

string

Opcional. Quando definido, qual modo de particionamento do Hive usar ao ler dados. Estes são os modos compatíveis:

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

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

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

Nem todos os formatos de armazenamento são compatíveis com o particionamento do Hive. Solicitar o particionamento do Hive em um formato não compatível vai gerar um erro. Os formatos compatíveis no momento são: JSON, CSV, ORC, Avro e Parquet.

sourceUriPrefix

string

Opcional. Quando a detecção de partição do Hive é solicitada, um prefixo comum para todos os URIs de origem é obrigatório. O prefixo precisa terminar imediatamente antes do início da codificação da chave de partição. Por exemplo, considere arquivos com este layout 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 o particionamento do Hive é solicitado com a detecção AUTO ou STRINGS, o prefixo comum pode ser gs://bucket/path_to_table ou gs://bucket/path_to_table/.

A detecção CUSTOM exige a codificação do esquema de particionamento imediatamente após o prefixo comum. Para CUSTOM, qualquer uma das seguintes opções:

  • 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 definido como "true", as consultas nessa tabela exigem um filtro de partição que possa ser usado para especificar a eliminação de partições.

Esse campo só será verdadeiro ao criar uma tabela externa permanente ou consultar uma tabela externa temporária.

Os carregamentos particionados do Hive com require_partition_filter definido explicitamente como "true" vão falhar.

fields[]

string

Apenas saída. Para tabelas externas permanentes, esse campo é preenchido com as chaves de partição do Hive na 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 esse campo na saída. Por exemplo, "Tables.Get" vai preencher esse campo, mas "Tables.List" não.

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

boolean

Opcional. Se "sourceFormat" for definido como "AVRO", indica se é necessário interpretar os tipos lógicos como o tipo de dados correspondente do BigQuery (por exemplo, TIMESTAMP), em vez de usar o tipo bruto (por exemplo, INTEGER).

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

boolean

Opcional. Indica se é necessário inferir o tipo lógico ENUM do Parquet como STRING em vez de BYTES por padrão.

enableListInference

boolean

Opcional. Indica se é necessário usar a inferência de esquema especificamente para o tipo lógico Parquet LIST.

mapTargetType

enum (MapTargetType)

Opcional. Indica como representar um mapa do Parquet, se houver.

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

string

Opcional. A conexão que especifica as credenciais a serem usadas para leitura e gravação em 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 local totalmente qualificado da pasta externa em que os dados da tabela são armazenados. O caractere curinga "*" não é permitido. O URI precisa estar no formato gs://bucket/path_to_table/

fileFormat

enum (FileFormat)

Opcional. O formato do arquivo em que os dados da tabela são armazenados.

tableFormat

enum (TableFormat)

Opcional. O formato da tabela em que os snapshots somente de metadados são armazenados.

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

string

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

estimatedRows

string

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

oldestEntryTime

string (uint64 format)

Apenas saída. Contém o carimbo de data/hora da entrada mais antiga no buffer de streaming, em milissegundos desde a época, se o buffer de streaming estiver disponível.

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

string

Opcional. Descreve a chave de criptografia do Cloud KMS que será usada para proteger a tabela de destino do BigQuery. A conta de serviço do BigQuery associada ao seu projeto precisa de acesso a essa chave de criptografia.

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

object (TableReference)

Obrigatório. Referência que descreve o ID da tabela que foi incluída no snapshot.

snapshotTime

string (Timestamp format)

Obrigatório. A hora em que a tabela de base foi capturada. Esse valor é informado na resposta JSON usando o formato RFC3339.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. 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 clonada.

cloneTime

string (Timestamp format)

Obrigatório. A hora em que a tabela base foi clonada. Esse valor é informado na resposta JSON usando o formato RFC3339.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. 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 primária nas colunas de uma tabela. Presente apenas se a tabela tiver uma chave primária. A chave primária não é aplicada.

foreignKeys[]

object (ForeignKey)

Opcional. Presente somente 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 compõem a restrição de chave primária.

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

string

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

referencedTable

object (TableReference)

Obrigatório. A tabela que contém a chave primária e é referenciada por essa 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 primária 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 em que a tabela de origem é pesquisada para atualizações. É opcional. Se não for especificado, o intervalo de replicação padrão será aplicado.

replicatedSourceLastRefreshTime

string (int64 format)

Opcional. Apenas saída. Se a origem for uma visualização materializada, esse campo vai indicar a última atualização dela.

replicationStatus

enum (ReplicationStatus)

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

replicationError

object (ErrorProto)

Opcional. Apenas saída. Erro de replicação que 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 com 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 dessa tabela.

connectionId

string

Opcional. Um ID de conexão que especifica as credenciais a serem usadas para ler o armazenamento externo, como Azure Blob, Cloud Storage ou Amazon S3. Essa conexão é necessária para ler a tabela de código aberto do BigQuery. O formato de "connection_id" precisa 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. O local físico da tabela (por exemplo, gs://spark-dataproc-data/pangea-data/case_sensitive/ ou gs://spark-dataproc-data/pangea-data/*). O comprimento máximo é de 2.056 bytes.

inputFormat

string

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

outputFormat

string

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

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 tamanho máximo é de 256 caracteres.

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. O tamanho máximo é de 256 caracteres.

parameters

map (key: string, value: string)

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

Um objeto com 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

Dica destrutiva: ❌ | Dica idempotente: ✅ | Dica somente leitura: ✅ | Dica de mundo aberto: ❌