DESCRIBE TABLE

S’applique à :case marquée oui Databricks SQL case marquée oui Databricks Runtime

Retourne les informations de base sur les métadonnées d’une table. Ces métadonnées incluent le nom de colonne, le type de colonne et le commentaire de colonne. Vous pouvez éventuellement ajouter une spécification de partition ou un nom de colonne pour retourner les métadonnées relatives à une partition ou à une colonne, respectivement. Avec les tables Delta, tous les champs ne sont pas retournés.

Syntaxe

{ DESC | DESCRIBE } [ TABLE ] [ EXTENDED | FORMATTED ] table_name { [ PARTITION clause ] | [ column_name ] }

Paramètres

  • EXTENDED ou FORMATTED

    Si ces données sont fournies, elles affichent des informations détaillées sur les colonnes spécifiées, y compris les statistiques de colonne collectées par la commande, ainsi que d’autres informations de métadonnées (notamment le qualificateur de schéma, le propriétaire et le temps d’accès).

  • table_name

    Identifie la table à décrire. Le nom ne peut pas inclure une spécification temporelle. Si la table est introuvable, Azure Databricks génère une erreur TABLE_OR_VIEW_NOT_FOUND.

  • Clause PARTITION

    Paramètre facultatif demandant à Databricks SQL de retourner d’autres métadonnées pour les partitions nommées.

  • column_name

    Paramètre facultatif avec le nom de colonne qui doit être décrit. Les colonnes actuellement imbriquées ne peuvent pas être spécifiées.

Les paramètres partition_spec et column_name s’excluent mutuellement et ne peuvent pas être spécifiés ensemble.

Exemples

-- Creates a table `customer`. Assumes current schema is `salesdb`.
> CREATE TABLE customer(
        cust_id INT,
        state VARCHAR(20),
        name STRING COMMENT 'Short name'
    )
    USING parquet
    PARTITIONED BY (state);

> INSERT INTO customer PARTITION (state = 'AR') VALUES (100, 'Mike');

-- Returns basic metadata information for unqualified table `customer`
> DESCRIBE TABLE customer;
                col_name data_type    comment
 ----------------------- --------- ----------
                 cust_id       int       null
                    name    string Short name
                   state    string       null
 # Partition Information
              # col_name data_type    comment
                   state    string       null

-- Returns basic metadata information for qualified table `customer`
> DESCRIBE TABLE salesdb.customer;
                col_name data_type    comment
 ----------------------- --------- ----------
                 cust_id       int       null
                    name    string Short name
                   state    string       null
 # Partition Information
              # col_name data_type    comment
                   state    string       null

-- Returns additional metadata such as parent schema, owner, access time etc.
> DESCRIBE TABLE EXTENDED customer;
                     col_name                      data_type    comment
 ---------------------------- ------------------------------ ----------
                      cust_id                            int       null
                         name                         string Short name
                        state                         string       null
      # Partition Information
                   # col_name                      data_type    comment
                        state                         string       null

 # Detailed Table Information
                     Database                        default
                        Table                       customer
                        Owner                  <TABLE OWNER>
                 Created Time   Tue Apr 07 22:56:34 JST 2020
                  Last Access                        UNKNOWN
                   Created By                <SPARK VERSION>
                         Type                        MANAGED
                     Provider                        parquet
                     Location file:/tmp/salesdb.db/custom...
                Serde Library org.apache.hadoop.hive.ql.i...
                  InputFormat org.apache.hadoop.hive.ql.i...
                 OutputFormat org.apache.hadoop.hive.ql.i...
           Partition Provider                        Catalog

-- Returns partition metadata such as partitioning column name, column type and comment.
> DESCRIBE TABLE EXTENDED customer PARTITION (state = 'AR');
                       col_name                      data_type    comment
 ------------------------------ ------------------------------ ----------
                         cust_id                            int       null
                           name                         string Short name
                          state                         string       null
        # Partition Information
                     # col_name                      data_type    comment
                          state                         string       null

 # Detailed Partition Inform...
                       Database                        default
                          Table                       customer
               Partition Values                     [state=AR]
                       Location file:/tmp/salesdb.db/custom...
                  Serde Library org.apache.hadoop.hive.ql.i...
                    InputFormat org.apache.hadoop.hive.ql.i...
                   OutputFormat org.apache.hadoop.hive.ql.i...
             Storage Properties [serialization.format=1, pa...
           Partition Parameters {transient_lastDdlTime=1586...
                   Created Time   Tue Apr 07 23:05:43 JST 2020
                    Last Access                        UNKNOWN
           Partition Statistics                      659 bytes

          # Storage Information
                       Location file:/tmp/salesdb.db/custom...
                  Serde Library org.apache.hadoop.hive.ql.i...
                    InputFormat org.apache.hadoop.hive.ql.i...
                   OutputFormat org.apache.hadoop.hive.ql.i...
 ------------------------------ ------------------------------ ----------

-- Returns the metadata for `name` column.
-- Optional `TABLE` clause is omitted and column is fully qualified.
> DESCRIBE customer salesdb.customer.name;
 info_name info_value
 --------- ----------
  col_name       name
 data_type     string
   comment Short name

DESCRIBE DETAIL

DESCRIBE DETAIL [schema_name.]table_name

DESCRIBE DETAIL delta.`<path-to-table>`

Retourner des informations sur le schéma, le partitionnement, la taille de la table, etc. Par exemple, pour les tables Delta, vous pouvez voir les versions actuelles du lecteur et du rédacteur d’une table. Pour plus d’informations sur le schéma, consultez Examiner les détails de la table Delta Lake avec les détails de description.