Formatta l'output dell'interfaccia a riga di comando cbt

Questo documento descrive come formattare tipi specifici di dati archiviati nelle righe di Bigtable quando vengono visualizzati dall'interfaccia a riga di comando cbt.

Esempi di formattazione

A partire dalla versione 0.12.0, la cbt CLI può formattare determinati tipi complessi di dati archiviati nelle righe della tabella. Quando utilizzi il comando cbt read o cbt lookup, la cbt CLI può "stampare in un formato gradevole" i valori memorizzati nelle righe.

L'esempio seguente mostra l'output dei dati della cbt CLI senza formattazione.

----------------------------------------
r1
  fam1:col1                                 @ 2022/03/09-11:19:45.966000
    "\n\x05Brave\x10\x02"
  fam1:col2                                 @ 2022/03/14-11:17:20.014000
    "{\"name\": \"Brave\", \"age\": 2}"

L'esempio seguente mostra l'output dei dati della cbt CLI con formattazione.

r1
  fam1:col1                                 @ 2022/03/09-11:19:45.966000
    name: "Brave"
    age: 2
  fam1:col2                                 @ 2022/03/14-11:17:20.014000
    age:     2.00
    name:   "Brave"

Per formattare una colonna o una famiglia di colonne, devi fornire un file YAML che specifichi la formattazione della colonna. Quando chiami cbt lookup o cbt read, devi passare il percorso del file YAML con l'argomento format-file. Lo snippet seguente mostra un esempio di chiamata a cbt lookup con l'argomento format-file fornito.

cbt lookup my-table r1 format-file=/path/to/formatting.yml

Definire i formati dei dati delle colonne in YAML

Il file YAML di formattazione deve collegare i nomi delle colonne o famiglia di colonne con i tipi di dati memorizzati al loro interno. Lo snippet seguente mostra un esempio di file di formattazione YAML.

protocol_buffer_definitions:
  - cat.proto
protocol_buffer_paths:
  - testdata/


columns:
  col1:
    encoding: ProtocolBuffer
    type: Cat

  col2:
    encoding: json

Lo snippet seguente mostra i contenuti di "cat.proto".

syntax = "proto3";
package cats;

option go_package = "github.com/protocolbuffers/protobuf/examples/go/tutorialpb";

message Cat {
  string name = 1;
  int32 age = 2;
}

Esempio:

  • Il campo protocol_buffer_definitions fornisce un elenco di file .proto che possono contenere tipi di messaggi di buffer di protocollo da utilizzare per decodificare i dati protobuf.
  • Il campo protocol_buffer_paths fornisce un elenco di percorsi locali che possono contenere file .proto per la decodifica dei tipi di buffer del protocollo. Non è necessario specificare le posizioni delle importazioni del buffer del protocollo standard, ad esempio i messaggi nel pacchetto google/protobuf.

  • Il campo columns contiene un elenco di nomi di colonne con i tipi di dati corrispondenti per ogni colonna:

    • La colonna protobuf ha encoding impostato su "ProtocolBuffer" e type impostato su "Cat". La cbt CLI interprete e formatta tutti i valori memorizzati in questa colonna come tipo di messaggio Cat proto. Il tipo deve corrispondere a un tipo di messaggio definito in uno dei file .proto forniti per il campo protocol_buffer_definition.
    • Il campo encoding della colonna json è impostato su "json". cbtinterpreta e formatta tutti i valori memorizzati in questa colonna come struttura JSON.

Altri campi che puoi fornire:

  • default_encoding: questo campo definisce una formattazione predefinita per tutte le colonne di una tabella o di una famiglia di colonne.
  • default_type: questo campo definisce un tipo di dati predefinito per le colonne con codifica Protocol Buffer, big endian e little endian.

  • families: questo campo definisce le codifiche e i tipi per tutte le colonne all'interno di una famiglia di colonne. Puoi fornire un default_encoding e un default_type per una famiglia di colonne. Puoi anche sostituire queste codifiche a livello di colonna fornendo un campo columns che elenchi le colonne per nome con la codifica e i tipi di dati appropriati, come mostrato nello snippet seguente:

    families:
  family1:
    default_encoding: BigEndian
    default_type: INT64
    columns:
      address:
        encoding: PROTO
        type: tutorial.Person

Tipi di dati supportati

La cbtCLI supporta la formattazione di diversi tipi di dati complessi. La tabella seguente elenca i tipi di dati e le stringhe supportati da fornire nel file YAML per ciascun tipo di elenco. I valori delle stringhe non sono sensibili alle maiuscole.

Tipo di dati Valore di formattazione per YAML
Esadecimale Hex, H
Big endian BigEndian, B
Little-endian LittleEndian, L
Buffer di protocollo ProtocolBuffer, P, PROTO
JSON JSON, J

Tabella 1. Tipi di dati supportati per la formattazione nell'output cbt.

  • La codifica esadecimale è indipendente dal tipo. I dati vengono visualizzati come rappresentazione esadecimale non elaborata dei dati archiviati.
  • I tipi disponibili per le codifiche big-endian e little-endian sono int8, int16, int32, int64, uint8, uint16, uint32, uint64, float32 e float64. La lunghezza dei dati archiviati deve essere un multiplo del dimensione del tipo, in byte. I dati vengono visualizzati come scalari se la lunghezza memorizzata corrisponde alla dimensione del tipo oppure come array in caso contrario. I nomi dei tipi non fanno distinzione tra maiuscole e minuscole.
  • I tipi specificati per la codifica protocol-buffer devono corrispondere ai tipi di messaggio definiti nei file di definizione del protocollo-buffer forniti. I tipi non sono sensibili alle maiuscole. Se non viene specificato alcun tipo, viene utilizzato per impostazione predefinita il nome della colonna per i dati della colonna visualizzati.
  • I valori di formattazione per YAML non sono sensibili alle maiuscole.