Résumé de DBMS_CATALOG

Cette section couvre les sous-programmes DBMS_CATALOG fournis avec Oracle Autonomous AI Database.

Les sous-programmes sont classés dans les domaines fonctionnels suivants.

Montage et démontages du catalogue

Sous-programme Description

Procédure MOUNT_DATA_CATALOG

Cette procédure monte un catalogue de données tel qu'AWS GLUE ou OCI Data Catalog.

Procédure MOUNT_DB_LINK

Cette procédure monte un catalogue en fonction d'un lien de base de données.

Procédure MOUNT_ICEBERG

Cette procédure monte un catalogue Apache Iceberg avec des configurations spécifiques.

Procédure MOUNT_SHARE

Cette procédure monte un catalogue unique en fonction d'un partage.

Procédure MOUNT_SHARES

Cette procédure monte plusieurs catalogues à partir d'un fournisseur de partage, avec des surcharges pour prendre en charge différents types d'entrée.

Procédure MOUNT_VIRTUAL_CATALOG

Cette procédure crée et monte un nouveau catalogue virtuel.

Procédure UNMOUNT

Cette procédure démonte un catalogue externe existant.

Gestion des propriétés de catalogue

Sous-programme Description

Procédure GET_CATALOG_PROPERTY

Procédure GET_CATALOG_PROPERTY_CLOB

Ces procédures extraient les valeurs de propriété d'un catalogue.

Procédure UPDATE_CATALOG_PROPERTY

Procédure UPDATE_CATALOG_PROPERTY_CLOB

Ces procédures mettent à jour les valeurs de propriété d'un catalogue.

Fonction GET_COLUMN_PROPERTY

Fonction GET_COLUMN_PROPERTY_CLOB

Ces fonctions extraient les valeurs de propriété d'une colonne spécifique au format VARCHAR2 ou CLOB.

Procédure UPDATE_COLUMN_PROPERTY

Procédure UPDATE_COLUMN_PROPERTY_CLOB

Ces procédures mettent à jour les valeurs de propriété d'une colonne spécifique avec des options permettant de transmettre les mises à jour à la source.

Procédure GET_SCHEMA_PROPERTY

Procédure GET_SCHEMA_PROPERTY_CLOB

Ces procédures extraient les valeurs de propriété de schéma.

Procédure UPDATE_SCHEMA_PROPERTY

Procédure UPDATE_SCHEMA_PROPERTY_CLOB

Ces procédures mettent à jour les valeurs de propriété de schéma.

Procédure GET_TABLE_PROPERTY

Procédure GET_TABLE_PROPERTY_CLOB

Ces procédures extraient les valeurs des propriétés de table.

Procédure UPDATE_TABLE_PROPERTY

Procédure UPDATE_TABLE_PROPERTY_CLOB

Ces procédures mettent à jour les valeurs des propriétés de table.

Fonction GET_CLOUD_STORAGE_LINK_PROPERTY

Fonction GET_CLOUD_STORAGE_LINK_PROPERTY_CLOB

Ces fonctions extraient les valeurs de propriété d'un lien de stockage cloud au format VARCHAR2 ou CLOB.

Procédure UPDATE_CLOUD_STORAGE_LINK_PROPERTY

Procédure UPDATE_CLOUD_STORAGE_LINK_PROPERTY_CLOB

Ces procédures mettent à jour les valeurs de propriété d'une liaison de stockage cloud.

Gestion des informations d'identification

Sous-programme Description

Procédure ADD_REQUIRED_CREDENTIAL

Cette procédure définit les informations d'identification requises pour un catalogue.

Procédure SUPPRIMER_REQUIRED_CREDENTIAL

Cette procédure supprime les informations d'identification requises d'un catalogue.

Procédure RENAME_REQUIRED_CREDENTIAL

Cette procédure renomme les informations d'identification requises.

Procédure GET_REQUIRED_CREDENTIAL_PROPERTY

Cette procédure extrait une propriété d'informations d'identification requises.

Procédure UPDATE_REQUIRED_CREDENTIAL_PROPERTY

Cette procédure met à jour une propriété d'informations d'identification requises.

Procédure GET_LOCAL_CREDENTIAL_MAP (surchargée)

Cette procédure extrait les mappages entre les informations d'identification requises et les informations d'identification locales, avec des surcharges pour différents formats de sortie.

Procédure SET_LOCAL_CREDENTIAL

Cette procédure indique des informations d'identification locales pour les informations d'identification requises.

Gestion des entités de catalogue

Sous-programme Description

Procédure CREATE_CLOUD_STORAGE_LINK

Procédure DROP_CLOUD_STORAGE_LINK

Ces procédures permettent de gérer les liens de stockage cloud dans un catalogue.

Fonction GET_CLOUD_STORAGE_LINKS

Cette fonction extrait les métadonnées des liens de stockage cloud dans un catalogue avec des filtres facultatifs.

Procédure CREATE_EXTERNAL_TABLE

Cette procédure crée une table externe dans un catalogue.

Procédure CREATE_SCHEMA

Cette procédure crée un schéma dans un catalogue et crée également un schéma Apache Iceberg dans les catalogues distants.

Procédure GET_OBJECTS

Procédure GET_SCHEMAS

Procédure GET_TABLES

Cette procédure extrait les métadonnées des tables, schémas et objets d'un catalogue à l'aide de fonctions pipelinées.

Procédure DROP_SCHEMA

Procédure DROP_TABLE

Cette procédure supprime les schémas et les tables d'un catalogue.

Fonction GET_COLUMNS

Cette fonction extrait les métadonnées des colonnes des tables ou des vues d'un catalogue.

Procédure GET_TABLE

Fonction GET_TABLE

Cette procédure et cette fonction extrait des informations détaillées sur une table spécifique au format d'enregistrement ou JSON.

Accès aux données et mise en cache

Sous-programme Description

Procédure GENERATE_TABLE_SELECT (surchargée)

Cette procédure crée une instruction SELECT pour une table logique, avec des surcharges pour la procédure et la fonction.

Procédure OPEN_TABLE_CURSOR

Cette procédure ouvre un curseur pour renvoyer les données d'une table logique.

Procédure FLUSH_CATALOG_CACHE

Procédure PREFILL_CATALOG_CACHE

Ces procédures gèrent la mise en cache des métadonnées de catalogue.

Synchronisation et partage

Sous-programme Description

Procédure CREATE_SYNCHRONIZED_SCHEMAS

Procédure DROP_SYNCHRONIZED_SCHEMAS

Ces procédures gèrent les schémas synchronisés avec les définitions de catalogue distant.

Procédure UPDATE_SYNCHRONIZED_SCHEMA_PROPERTY

Cette procédure met à jour les propriétés des schémas synchronisés.

Procédure SYNCHRONIZE_SHARED_CATALOGS

Cette procédure gère les catalogues correspondant aux partages non disponibles avec des options de démontage ou de désactivation.

Procédure CREATE_SYNCHRONIZED_VIEWS

Cette procédure crée des vues sur les tables de catalogue pour appliquer des restrictions.

Procédure COPY_TABLE_PROPERTIES

Cette procédure copie les propriétés d'une table à une autre, y compris les propriétés de colonne facultatives.

Procédure GRANT_TO_RECIPIENT

Procédure REVOKE_FROM_RECIPIENT

Ces procédures gèrent les droits d'accès des destinataires du catalogue.

Journalisation des événements

Sous-programme Description

Procédure CLEAR_CATALOG_EVENTS

Cette procédure efface les événements du journal des événements du catalogue dans une période donnée.

Gestion spécifique aux icebergs

Sous-programme Description

Procédure CREATE_ICEBERG_TABLE

Cette procédure crée une table Iceberg dans un schéma spécifié d'un catalogue.

Procédure ADD_ICEBERG_SNAPSHOT

Cette procédure ajoute un cliché à une table Iceberg pour représenter les modifications de données avec des métadonnées détaillées.

Procédure MOUNT_DATA_CATALOG

Cette procédure monte un catalogue de données (par exemple, AWS GLUE ou OCI Data Catalog).

Syntaxe

PROCEDURE mount_data_catalog
(
  catalog_name 				IN VARCHAR2,
  data_catalog_type 		IN VARCHAR2,
  data_catalog_region 		IN VARCHAR2,
  data_catalog_credential 	IN VARCHAR2,
  data_catalog_id 			IN VARCHAR2 := NULL,
  data_storage_credential 	IN VARCHAR2 := NULL,
  enabled 					IN BOOLEAN := TRUE
);

Paramètres

Paramètre Description

catalog_name

Nom du nouveau catalogue. Elle sera convertie en majuscules.

data_catalog_type

Type de catalogue de données (par exemple, OCI_DCAT ou AWS_GLUE).

data_catalog_region

Région de ressource cloud du catalogue de données.

data_catalog_credential

Informations d'identification locales utilisées pour accéder au catalogue de données.

data_catalog_id

Nom ou identifiant du catalogue de données. La valeur par défaut est NULL.

data_storage_credential

Elle indique les informations d'identification locales pour l'accès aux données. La valeur par défaut est NULL. Ce champ est facultatif.

enabled

Indique si le catalogue est activé pour la recherche. La valeur par défaut est TRUE.

Exemple

/****************** Glue Catalog ******************/
BEGIN
  -- Create a credential capable of accessing a glue catalog
  dbms_cloud.create_credential('GLUE_CATALOG_CREDENTIAL', ...); 

  -- Mount a glue catalog
  dbms_catalog.mount_data_catalog(
    catalog_name             => 'GLUE_CAT',
    data_catalog_type        => 'AWS_GLUE',
    data_catalog_region      => 'us-east-1', 
    data_catalog_credential  => 'GLUE_CATALOG_CREDENTIAL');
END;
/

Procédure MOUNT_DB_LINK

Cette procédure monte un catalogue externe en fonction d'un lien de base de données.

Syntaxe

PROCEDURE mount_db_link
(
  catalog_name 	IN VARCHAR2,
  db_link 		IN VARCHAR2,
  enabled 		IN BOOLEAN := TRUE
);

Paramètres

Paramètre Description

catalog_name

Nom du nouveau catalogue. Elle sera convertie en majuscules.

db_link

Lien de base de données à utiliser pour le montage du catalogue.

enabled

Indique si le catalogue est activé pour la recherche. La valeur par défaut est TRUE.

Procédure MOUNT_ICEBERG

Cette procédure monte un catalogue Iceberg.

Syntaxe

Pour plus d'informations sur le catalogue Iceberg, reportez-vous à Spécification de catalogue REST Iceberg.

PROCEDURE mount_iceberg
(
  catalog_name 				IN VARCHAR2,
  endpoint 					IN VARCHAR2,
  catalog_credential 		IN VARCHAR2,
  data_storage_credential 	IN VARCHAR2,
  configuration 			IN SYS.JSON_OBJECT_T := NULL,
  enabled 					IN BOOLEAN := TRUE,
  catalog_type 				IN VARCHAR2 := 'ICEBERG_GENERIC'
);

Paramètres

Paramètre Description

catalog_name

Nom du nouveau catalogue. Elle sera convertie en majuscules.

endpoint

URL du serveur de base Iceberg.

catalog_credential

Informations d'identification utilisées pour accéder au catalogue Iceberg.

data_storage_credential

Informations d'identification utilisées pour accéder aux données.

configuration

La configuration de catalogue est décrite comme un objet JSON.

Les configurations prises en charge sont les suivantes :
  • namespacePath : la valeur par défaut est NULL.
  • namespaceSeparator : la valeur par défaut est le point (.) pour Unity, %1F pour les autres catalogues Iceberg.
  • isCaseSensitive : la valeur par défaut est FALSE pour Unity, TRUE pour les autres catalogues Iceberg)
  • isPublicCatalog : la valeur par défaut est FALSE.
  • bucketRegion : la valeur par défaut est NULL. Elle n'est pertinente que si le catalogue utilise le stockage S3.
enabled

Indique si le catalogue est activé pour la recherche. La valeur par défaut est TRUE.

catalog_type

Type de catalogue d'icebergs (par exemple, ICEBERG_GENERIC, ICEBERG_POLARIS, ICEBERG_UNITY). La valeur par défaut est ICEBERG_GENERIC.

Exemple

/****************** Iceberg Catalog - Unity ******************/
DECLARE
  config      JSON_OBJECT_T := JSON_OBJECT_T();
BEGIN
  -- Create a credential capable of accessing an external iceberg REST catalog
  dbms_share.create_bearer_token_credential(
    credential_name => 'ICEBERG_CATALOG_CREDENTIAL',
    token_endpoint => 'https://.../v1/tokens',
    client_id => ...,
    client_secret => ...,
    token_scope => 'all-apis');

  -- Create a credential capable of accessing the bucket where the 
  -- iceberg data files are stored.
  dbms_cloud.create_credential('ICEBERG_STORAGE_CRED', ...); 

  -- Mount a iceberg catalog
  config.put('namespacePath', 'sales_catalog');
  dbms_catalog.mount_iceberg(
    catalog_name             => 'ICEBERG_CAT',
    endpoint                 => 'https://...//api/2.1/unity-catalog/iceberg/v1',
    catalog_credential       => 'ICEBERG_CATALOG_CREDENTIAL',
    data_storage_credential  => 'ICEBERG_STORAGE_CRED',
    configuration            => config,
    catalog_type             => 'ICEBERG_UNITY');
END;
/

/****************** Iceberg Catalog - Polaris ******************/
DECLARE
  config      JSON_OBJECT_T := JSON_OBJECT_T();
BEGIN
  -- Create a credential capable of accessing an external iceberg REST catalog
  dbms_share.create_bearer_token_credential(
    credential_name => 'ICEBERG_CATALOG_CREDENTIAL',
    token_endpoint => 'https://.../v1/oauth/tokens',
    client_id => ...,
    client_secret => ...,
    token_scope => 'PRINCIPAL_ROLE:ALL');

  -- Create a credential capable of accessing the bucket where the 
  -- iceberg data files are stored.
  dbms_cloud.create_credential('ICEBERG_STORAGE_CRED', ...); 

  -- Mount a iceberg catalog
  config.put('namespacePath', 'sales_catalog');
  dbms_catalog.mount_iceberg(
    catalog_name             => 'ICEBERG_CAT',
    endpoint                 => 'https://.../polaris/api/catalog/v1',
    catalog_credential       => 'ICEBERG_CATALOG_CREDENTIAL',
    data_storage_credential  => 'ICEBERG_STORAGE_CRED',
    configuration            => config,
    catalog_type             => 'ICEBERG_POLARIS');
END;
/

Procédure MOUNT_SHARE

Cette procédure monte un catalogue en fonction d'un partage unique.

Syntaxe

PROCEDURE mount_share
(
  catalog_name 				IN VARCHAR2,
  share_provider 			IN VARCHAR2,
  share_name 				IN VARCHAR2,
  share_provider_owner 		IN VARCHAR2 := NULL,
  enabled 					IN BOOLEAN := TRUE
);

Paramètres

Paramètre Description

catalog_name

Nom du nouveau catalogue. Elle sera convertie en majuscules.

share_provider

Nom du fournisseur de partage.

share_name

Nom du partage à monter.

share_provider_owner

Propriétaire du fournisseur de partage. Par défaut, le catalogue actuel est défini sur NULL.

enabled

Indique si le catalogue est activé pour la recherche. La valeur par défaut est TRUE.

Exemple

/****************** Share Catalog ******************/
BEGIN
  -- Create a share provider
  dbms_share.create_or_replace_share_provider(
    provider_name        => 'MY_SHARE_PROVIDER',
    endpoint             => 'https://...');
  dbms_cloud.create_credential(
    credential_name      => 'SHARE_PROVIDER_CREDENTIAL', ...);
  dbms_share.set_share_provider_credential(
    provider_name        => 'MY_SHARE_PROVIDER',
    share_credential     => 'SHARE_PROVIDER_CREDENTIAL');

  -- Mount a share catalog
  dbms_catalog.mount_share(
    catalog_name         => 'SHARE_CAT',
    share_provider       => 'MY_SHARE_PROVIDER',
    share_name           => 'MY_SHARE_1');
END;
/

Procédure MOUNT_SHARES

Cette procédure monte plusieurs catalogues en fonction des partages d'un fournisseur de partage.

Syntaxe

PROCEDURE mount_shares
(
  share_provider 		IN VARCHAR2,
  shares 				IN SYS.JSON_ARRAY_T,
  created_catalogs 		IN OUT NOCOPY SYS.JSON_ARRAY_T,
  share_provider_owner 	IN VARCHAR2 := NULL
);

Paramètres

Paramètre Description

share_provider:

Nom du fournisseur de partage.

shares

Tableau JSON définissant la liste des partages à monter. Chaque élément indique des propriétés telles que shareName, required, shareNameRule, catalogName, skipExisting, placeholder et enabled.

created_catalogs

Tableau JSON des catalogues nouvellement créés, renvoyé en sortie avec des propriétés telles que shareName et catalogName.

share_provider_owner

Propriétaire du fournisseur de partage. Par défaut, le catalogue actuel est défini sur NULL.

Syntaxe de la seconde procédure

PROCEDURE mount_shares
(
  share_provider 		IN VARCHAR2,
  shares 				IN SYS.JSON_ARRAY_T,
  share_provider_owner 	IN VARCHAR2 := NULL
);

Syntaxe de la troisième procédure

PROCEDURE mount_shares
(
  share_provider 		IN VARCHAR2,
  shares 				IN CLOB := '[{shareName:"%"}]',
  share_provider_owner 	IN VARCHAR2 := NULL
);

Paramètres de la deuxième procédure

Les paramètres sont identiques à la procédure 1, sauf sans created_catalogs.

Paramètres de la troisième procédure

Les paramètres sont identiques à la signature 1, sauf que les partages sont un CLOB avec une valeur par défaut qui inclut tous les partages.

Exemple

/****************** Share Catalog ******************/
BEGIN
  -- Create a share provider
  dbms_share.create_or_replace_share_provider(
    provider_name        => 'MY_SHARE_PROVIDER',
    endpoint             => 'https://...');
  dbms_cloud.create_credential(
    credential_name      => 'SHARE_PROVIDER_CREDENTIAL', ...);
  dbms_share.set_share_provider_credential(
    provider_name        => 'MY_SHARE_PROVIDER',
    share_credential     => 'SHARE_PROVIDER_CREDENTIAL');

  -- Mount shares as catalogs
  dbms_catalog.mount_shares(
    share_provider       => 'MY_SHARE_PROVIDER');
END;
/

Procédure MOUNT_VIRTUAL_CATALOG

Cette procédure crée et monte un nouveau catalogue virtuel.

Syntaxe

PROCEDURE mount_virtual_catalog
(
  catalog_name 	IN VARCHAR2,
  enabled 		IN BOOLEAN := TRUE
);

Paramètres

Paramètre Description

catalog_name

Nom du nouveau catalogue. Elle sera convertie en majuscules.

enabled

Indique si le catalogue est activé pour la recherche. La valeur par défaut est TRUE.

Procédure UNMOUNT

Cette procédure permet de démonter un catalogue externe.

Syntaxe

PROCEDURE unmount
(
  catalog_name IN VARCHAR2
);

Paramètres

Paramètre Description

catalog_name

Nom d'un catalogue existant à démonter. Elle sera convertie en majuscules.

Procédure GET_CATALOG_PROPERTY

Cette procédure renvoie la valeur d'une propriété pour un catalogue.

Syntaxe

FUNCTION get_catalog_property
(
  catalog_name 		IN VARCHAR2,
  catalog_property 	IN VARCHAR2
)
RETURN VARCHAR2;

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

catalog_property

Il décrit la propriété à extraire (par exemple, PROP_CACHE_DURATION, PROP_IS_ENABLED).

La valeur peut être l'une des constantes suivantes :
  • PROP_CACHE_ASYNC
  • PROP_CACHE_DURATION
  • PROP_CACHE_ENABLED
  • PROP_CONFIGURATION
  • PROP_CUSTOM
  • PROP_DCAT_TYPE
  • PROP_DEFAULT_SCHEMA
  • PROP_IS_ENABLED
  • PROP_METADATA

Pour plus d'informations, voir Types de catalogue et constantes.

Procédure GET_CATALOG_PROPERTY_CLOB

Cette procédure renvoie la valeur d'une propriété pour un catalogue au format CLOB.

Syntaxe

FUNCTION get_catalog_property_clob
(
  catalog_name 		IN VARCHAR2,
  catalog_property 	IN VARCHAR2
)
RETURN CLOB;

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

catalog_property

Elle décrit la propriété à extraire (par exemple, PROP_CACHE_DURATION, PROP_IS_ENABLED).

La valeur peut être l'une des constantes suivantes :
  • PROP_CACHE_ASYNC
  • PROP_CACHE_DURATION
  • PROP_CACHE_ENABLED
  • PROP_CONFIGURATION
  • PROP_CUSTOM
  • PROP_DCAT_TYPE
  • PROP_DEFAULT_SCHEMA
  • PROP_IS_ENABLED
  • PROP_METADATA

Pour plus d'informations, voir Types de catalogue et constantes.

Procédure UPDATE_CATALOG_PROPERTY

Cette procédure met à jour la valeur d'une propriété pour un catalogue.

Syntaxe

PROCEDURE update_catalog_property
(
  catalog_name 		IN VARCHAR2,
  catalog_property 	IN VARCHAR2,
  new_value 		IN VARCHAR2
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

catalog_property

Elle décrit la propriété à mettre à jour (par exemple, PROP_CACHE_DURATION, PROP_IS_ENABLED).

La valeur peut être l'une des constantes suivantes :
  • PROP_CACHE_ASYNC
  • PROP_CACHE_DURATION
  • PROP_CACHE_ENABLED
  • PROP_CONFIGURATION
  • PROP_CUSTOM
  • PROP_DEFAULT_SCHEMA
  • PROP_IS_ENABLED
  • PROP_METADATA

Pour plus d'informations, voir Types de catalogue et constantes.

new_value

Nouvelle valeur de propriété.

Procédure UPDATE_CATALOG_PROPERTY_CLOB

Cette procédure met à jour la valeur d'une propriété pour un catalogue dans CLOB.

Syntaxe

PROCEDURE update_catalog_property_clob
(
  catalog_name 		IN VARCHAR2,
  catalog_property 	IN VARCHAR2,
  new_value 		IN CLOB
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

catalog_property

Elle décrit la propriété à extraire (par exemple, PROP_CACHE_DURATION, PROP_IS_ENABLED).

new_value

Nouvelle valeur de propriété dans CLOB.

Fonction GET_COLUMN_PROPERTY

Extrait une valeur de propriété spécifique, par exemple PROP_CUSTOM, PROP_METADATA, pour une colonne d'une table de catalogue.

Syntaxe

FUNCTION GET_COLUMN_PROPERTY
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  column_name                    IN VARCHAR2,
  column_property                IN VARCHAR2
)
RETURN VARCHAR2;

Paramètres

Paramètre Description

catalog_name

Nom du catalogue source. La valeur est en majuscules.

schema_name

Nom du schéma de catalogue source.

table_name

Nom de la table de catalogue source.

column_name

nom de la colonne.

column_property

Renvoie la valeur de la propriété, par exemple PROP_CUSTOM, PROP_METADATA.

Fonction GET_COLUMN_PROPERTY_CLOB

Extrait une valeur de propriété spécifique pour une colonne en tant qu'objet CLOB (Character Large Object).

Syntaxe

FUNCTION GET_COLUMN_PROPERTY_CLOB
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  column_name                    IN VARCHAR2,
  column_property                IN VARCHAR2
)
RETURN VARCHAR2;

Paramètres

Paramètre Description

catalog_name

Nom du catalogue source. La valeur est en majuscules.

schema_name

Nom du schéma de catalogue source.

table_name

Nom de la table de catalogue source.

column_name

nom de la colonne.

column_property

Renvoie la valeur de la propriété, par exemple PROP_CUSTOM, PROP_METADATA.

Procédure UPDATE_COLUMN_PROPERTY

Met à jour la valeur de propriété d'une colonne spécifique, avec une option permettant de propager la mise à jour vers les annotations d'objet source.

Syntaxe

PROCEDURE UPDATE_COLUMN_PROPERTY
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  column_name                    IN VARCHAR2,
  column_property                IN VARCHAR2,
  new_value                      IN VARCHAR2,
  push_to_source                 IN BOOLEAN := FALSE
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue source. La valeur est en majuscules.

schema_name

Nom du schéma de catalogue source.

table_name

Nom de la table de catalogue source.

column_name

nom de la colonne.

column_property

Met à jour la valeur de la propriété, par exemple PROP_CUSTOM, PROP_METADATA

new_value

Affecte une nouvelle valeur à la propriété.

push_to_source

Indique si la mise à jour de propriété doit être poussée vers les annotations d'objet source.

La valeur par défaut est FALSE.

Procédure UPDATE_COLUMN_PROPERTY_CLOB

Met à jour la valeur de propriété d'une colonne spécifique en tant qu'objet CLOB (Character Large Object) pour les données volumineuses, avec une option permettant de propager la mise à jour vers les annotations d'objet source.

Syntaxe

PROCEDURE UPDATE_COLUMN_PROPERTY_CLOB
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  column_name                    IN VARCHAR2,
  column_property                IN VARCHAR2,
  new_value                      IN CLOB,
  push_to_source                 IN BOOLEAN := FALSE
);

Paramètres

Paramètre Description
catalog_name

Nom du catalogue source. La valeur est en majuscules.

schema_name

Nom du schéma de catalogue source.

table_name

Nom de la table de catalogue source.

column_name

nom de la colonne.

column_property

Met à jour la valeur de la propriété, par exemple PROP_CUSTOM, PROP_METADATA

new_value

Affecte une nouvelle valeur au format CLOB.

push_to_source

Indique si la mise à jour de propriété doit être poussée vers les annotations d'objet source.

La valeur par défaut est FALSE.

Procédure GET_SCHEMA_PROPERTY

Cette procédure renvoie la valeur d'une propriété pour un schéma.

Syntaxe

FUNCTION get_schema_property
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  schema_property 	IN VARCHAR2
)

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

schema_name

Nom du schéma.

schema_property

Elle décrit la propriété à extraire (par exemple, PROP_CUSTOM, PROP_METADATA).

Procédure GET_SCHEMA_PROPERTY_CLOB

Cette procédure renvoie la valeur d'une propriété pour un schéma au format CLOB.

Syntaxe

FUNCTION get_schema_property_clob
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  schema_property 	IN VARCHAR2
)
RETURN CLOB;

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

schema_name

Nom du schéma.

schema_property

Elle décrit la propriété à extraire (par exemple, PROP_CUSTOM, PROP_METADATA).

Procédure UPDATE_SCHEMA_PROPERTY

Cette procédure renvoie la valeur d'une propriété pour un schéma.

Syntaxe

PROCEDURE update_schema_property
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  schema_property 	IN VARCHAR2,
  new_value 		IN VARCHAR2
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

schema_name

Nom du schéma.

schema_property

Elle décrit la propriété à extraire (par exemple, PROP_CUSTOM, PROP_METADATA).

new_value

Nouvelle valeur de propriété.

Procédure UPDATE_SCHEMA_PROPERTY_CLOB

Met à jour la valeur de propriété d'un schéma en tant qu'objet CLOB (Character Large Object) pour les données volumineuses.

Syntaxe

PROCEDURE UPDATE_SCHEMA_PROPERTY_CLOB
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  schema_property                IN VARCHAR2,
  new_value                      IN CLOB
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue source. La valeur est en majuscules.

schema_name

Nom du schéma de catalogue source.

schema_property

Met à jour la valeur de la propriété, par exemple PROP_CUSTOM, PROP_METADATA

new_value

Affecte une nouvelle valeur à la propriété.

Procédure GET_TABLE_PROPERTY

Renvoie la valeur d'une propriété pour une table.

Syntaxe

FUNCTION GET_TABLE_PROPERTY
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  table_property                 IN VARCHAR2
)
RETURN VARCHAR2;

Paramètres

Paramètre Description

catalog_name

Nom du catalogue source. La valeur est en majuscules.

schema_name

Nom du schéma de catalogue source.

table_name

Nom de la table de catalogue source.

table_property

Propriété à extraire.

Procédure GET_TABLE_PROPERTY_CLOB

Cette procédure renvoie la valeur d'une propriété pour une table au format CLOB.

Syntaxe

FUNCTION get_table_property_clob
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  table_name 		IN VARCHAR2,
  table_property 	IN VARCHAR2
)
RETURN CLOB;

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

schema_name

Nom du schéma.

table_name

Nom de la table.

table_property

Propriété à mettre à jour (par exemple, PROP_CUSTOM).

Procédure UPDATE_TABLE_PROPERTY

Cette procédure met à jour la valeur d'une propriété pour une table.

Syntaxe

PROCEDURE update_table_property
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  table_name 		IN VARCHAR2,
  table_property 	IN VARCHAR2,
  new_value 		IN VARCHAR2
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

schema_name

Nom du schéma.

table_name

Nom de la table.

table_property

Propriété à mettre à jour.

new_value

Nouvelle valeur de propriété.

Procédure UPDATE_TABLE_PROPERTY_CLOB

Met à jour la valeur d'une propriété de table à l'aide d'un type de données CLOB (Character Large Object).

Syntaxe

PROCEDURE UPDATE_TABLE_PROPERTY_CLOB
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  table_property                 IN VARCHAR2,
  new_value                      IN CLOB,
  push_to_source                 IN BOOLEAN := FALSE
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue source. La valeur est en majuscules.

schema_name

Nom du schéma de catalogue source.

table_name

Nom de la table de catalogue source.

table_property

Propriété de table à mettre à jour.

new_value

Affecte une nouvelle valeur au format CLOB.

push_to_source

Indique si la mise à jour de propriété doit être poussée vers les annotations d'objet source.

La valeur par défaut est FALSE.

Procédure ADD_REQUIRED_CREDENTIAL

Définit les informations d'identification requises pour utiliser le catalogue.

Syntaxe

PROCEDURE ADD_REQUIRED_CREDENTIAL
(
  catalog_name                   IN VARCHAR2,
  required_credential            IN VARCHAR2,
  local_credential               IN VARCHAR2 := NULL,
  credential_type                IN VARCHAR2 := NULL
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue source. La valeur est en majuscules.

required_credential

Nom des informations d'identification requises.

local_credential

Il s'agit d'informations d'identification locales facultatives à utiliser.

Valeur par défaut : NULL.

credential_type

Facultatif

Ce paramètre spécifie le type de mécanisme d'authentification utilisé pour accéder à des services externes, tels que le stockage d'objets ou d'autres bases de données. Par exemple, oci, aws, azure ou slack_credential.

Pour plus d'informations, voir Types de catalogue et constantes.

Procédure REMOVE_REQUIRED_CREDENTIAL

Cette procédure supprime les informations d'identification requises d'un catalogue.

Syntaxe

PROCEDURE remove_required_credential
(
  catalog_name 			IN VARCHAR2,
  required_credential 	IN VARCHAR2
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

required_credential

Nom des informations d'identification requises à enlever.

Procédure RENAME_REQUIRED_CREDENTIAL

Cette procédure renomme les informations d'identification requises à partir d'un catalogue.

Syntaxe

PROCEDURE rename_required_credential
(
  catalog_name 			IN VARCHAR2,
  old_credential_name 	IN VARCHAR2,
  new_credential_name 	IN VARCHAR2
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

old_credential_name

Ancien nom des informations d'identification requises.

new_credential_name

Nouveau nom des informations d'identification requises.

Procédure GET_REQUIRED_CREDENTIAL_PROPERTY

Cette procédure extrait une propriété d'informations d'identification requises nommées.

Syntaxe

FUNCTION get_required_credential_property
(
  catalog_name 			IN VARCHAR2,
  required_credential 	IN VARCHAR2,
  credential_property 	IN VARCHAR2
)
RETURN VARCHAR2;

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

required_credential

Nom des informations d'identification requises.

credential_property

Nom de la propriété (par exemple, PROP_REQUIRED_CREDENTIAL_DESCRIPTION, PROP_REQUIRED_CREDENTIAL_VAULT_SECRET).

Procédure UPDATE_REQUIRED_CREDENTIAL_PROPERTY

Cette procédure met à jour une propriété d'informations d'identification requises nommées.

Syntaxe

PROCEDURE update_required_credential_property
(
  catalog_name 			IN VARCHAR2,
  required_credential 	IN VARCHAR2,
  credential_property 	IN VARCHAR2,
  new_value 			IN VARCHAR2
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

required_credential

Nom des informations d'identification requises.

credential_property

Nom de la propriété (par exemple, PROP_REQUIRED_CREDENTIAL_DESCRIPTION, PROP_REQUIRED_CREDENTIAL_VAULT_SECRET).

new_value

Nouvelle valeur de la propriété.

Procédure GET_LOCAL_CREDENTIAL_MAP (surchargée)

Cette procédure extrait une correspondance entre les informations d'identification requises et les informations d'identification locales.

Syntaxe 1

PROCEDURE get_local_credential_map
(
  catalog_name 		IN VARCHAR2,
  credential_map 	OUT NOCOPY credential_info_map
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

credential_map

Mappage rempli des informations d'identification.

Syntaxe 2

FUNCTION get_local_credential_map
(
  catalog_name 	IN VARCHAR2,
  show_errors 	IN NUMBER := 0,
  pretty_json 	IN NUMBER := 0
)
RETURN CLOB;

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant.

show_errors

Des messages d'erreur s'affichent pour les informations d'identification locales non valides. La valeur par défaut est 0.

pretty_json

Formatez le fichier JSON avec l'option PRETTY. La valeur par défaut est 0.

Syntaxe 3

PROCEDURE get_local_credential_map
(
  catalog_id 		IN NUMBER,
  credential_map 	OUT NOCOPY SYS.JSON_OBJECT_T
);

Paramètres

Paramètre Description

catalog_id

ID d'un catalogue existant de la colonne CATALOG_ID dans ALL_MOUNTED_CATALOGS.

credential_map

Correspondance renseignée en tant qu'objet JSON.

Procédure SET_LOCAL_CREDENTIAL

Cette procédure indique les informations d'identification locales à utiliser lors de l'utilisation d'un catalogue.

Syntaxe

PROCEDURE set_local_credential
(
  catalog_name 			IN VARCHAR2,
  required_credential 	IN VARCHAR2,
  local_credential 		IN VARCHAR2
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

required_credential

Nom des informations d'identification requises.

local_credential

Informations d'identification à utiliser.

Fonction GET_CLOUD_STORAGE_LINK_PROPERTY

Extrait une valeur de propriété spécifique, par exemple PROP_CUSTOM, PROP_METADATA, pour un lien de stockage cloud dans un catalogue.

Syntaxe

FUNCTION GET_CLOUD_STORAGE_LINK_PROPERTY
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  storage_link_name              IN VARCHAR2,
  storage_link_property          IN VARCHAR2
)
RETURN VARCHAR2;

Paramètres

Paramètre Description

catalog_name

Nom du catalogue source. La valeur est en majuscules.

schema_name

Nom du schéma de catalogue source.

storage_link_name

Nom de la liaison de stockage cloud.

storage_link_property

Renvoie la valeur de la propriété, par exemple PROP_CUSTOM, PROP_METADATA.

Fonction GET_CLOUD_STORAGE_LINK_PROPERTY_CLOB

Extrait une valeur de propriété spécifique pour un lien de stockage cloud en tant qu'objet CLOB (Character Large Object).

Syntaxe

FUNCTION GET_CLOUD_STORAGE_LINK_PROPERTY_CLOB
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  storage_link_name              IN VARCHAR2,
  storage_link_property          IN VARCHAR2
)
RETURN CLOB;

Paramètres

Paramètre Description

catalog_name

Nom du catalogue source. La valeur est en majuscules.

schema_name

Nom du schéma de catalogue source.

storage_link_name

Nom de la liaison de stockage cloud.

storage_link_property

Renvoie la valeur de la propriété, par exemple PROP_CUSTOM, PROP_METADATA.

Procédure UPDATE_CLOUD_STORAGE_LINK_PROPERTY

Met à jour une valeur de propriété spécifique pour un lien de stockage cloud dans un catalogue.

Syntaxe

PROCEDURE UPDATE_CLOUD_STORAGE_LINK_PROPERTY
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  storage_link_name              IN VARCHAR2,
  storage_link_property          IN VARCHAR2,
  new_value                      IN VARCHAR2
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue source. La valeur est en majuscules.

schema_name

Nom du schéma de catalogue source.

storage_link_name

Nom de la liaison de stockage cloud.

storage_link_property

Met à jour la valeur de la propriété, par exemple PROP_CUSTOM, PROP_METADATA

new_value

Affecte une nouvelle valeur à la propriété.

Procédure UPDATE_CLOUD_STORAGE_LINK_PROPERTY_CLOB

Met à jour une valeur de propriété spécifique pour un lien de stockage cloud en tant qu'objet CLOB (Character Large Object) pour les données plus volumineuses.

Syntaxe

PROCEDURE UPDATE_CLOUD_STORAGE_LINK_PROPERTY_CLOB
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  storage_link_name              IN VARCHAR2,
  storage_link_property          IN VARCHAR2,
  new_value                      IN CLOB
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue source. La valeur est en majuscules.

schema_name

Nom du schéma de catalogue source.

storage_link_name

Nom de la liaison de stockage cloud.

storage_link_property

Met à jour la valeur de la propriété, par exemple PROP_CUSTOM, PROP_METADATA

new_value

Affecte une nouvelle valeur au format CLOB.

Procédure CREATE_CLOUD_STORAGE_LINK

Cette procédure crée un lien de stockage cloud dans un catalogue.

Syntaxe

PROCEDURE create_cloud_storage_link
(
  catalog_name 			IN VARCHAR2,
  schema_name 			IN VARCHAR2,
  storage_link_name 	IN VARCHAR2,
  uri 					IN VARCHAR2,
  required_credential 	IN VARCHAR2 := NULL,
  enabled 				IN BOOLEAN := TRUE,
  replace_if_exists 	IN BOOLEAN := FALSE
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

schema_name:

Nom du schéma.

storage_link_name

Nom du lien de stockage.

uri

URI de bucket.

required_credential

Informations d'identification requises (ou NULL pour les buckets publics).

La valeur par défaut est NULL.

enabled

Indique si le lien de stockage est activé pour la recherche. La valeur par défaut est TRUE.

replace_if_exists

Remplacez le lien s'il existe déjà. La valeur par défaut est FALSE.

Procédure DROP_CLOUD_STORAGE_LINK

Cette procédure supprime un lien de stockage cloud d'un catalogue.

Syntaxe

PROCEDURE drop_cloud_storage_link
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  storage_link_name IN VARCHAR2
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

schema_name:

Nom du schéma.

storage_link_name

Nom du lien de stockage.

Fonction GET_CLOUD_STORAGE_LINKS

Extrait tout ou partie des liens de stockage cloud d'un catalogue.

Syntaxe

FUNCTION GET_CLOUD_STORAGE_LINKS
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2 := NULL,
  storage_link_name              IN VARCHAR2 := NULL,
  conditions                     IN VARCHAR2 := NULL,
  flags                          IN NUMBER := 0,
  result_limit                   IN NUMBER := NULL,
  column_flags                   IN NUMBER := 0
)
RETURN CATALOG_STORAGE_LINKS PIPELINED;

Paramètres

Paramètre Description

catalog_name

Nom du catalogue source. La valeur est en majuscules.

schema_name

(Facultatif)

Nom du schéma de catalogue source.

Valeur par défaut : NULL.

storage_link_name

(Facultatif)

Nom de la liaison de stockage cloud.

Valeur par défaut : NULL.

conditions

(Facultatif)

Expressions de filtre supplémentaires à l'aide de la syntaxe de lignage.

Valeur par défaut : NULL.

flags

(Facultatif)

Indicateurs pour un contrôle supplémentaire.

La valeur par défaut est 0 (zéro).

result_limit

(Facultatif)

Nombre maximum de lignes à renvoyer.

Valeur par défaut : NULL.

column_flags

(Facultatif)

Indicateurs de colonne, par exemple FETCH_PROPERTIES, FETCH_METADATA.

Fonction GET_COLUMNS

Extrait toutes les colonnes d'une table ou d'une vue dans un catalogue.

Syntaxe

FUNCTION GET_COLUMNS
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2 := NULL,
  parent_type                    IN VARCHAR2 := NULL,
  column_name                    IN VARCHAR2 := NULL,
  conditions                     IN VARCHAR2 := NULL,
  flags                          IN NUMBER := 0,
  result_limit                   IN NUMBER := NULL,
  column_flags                   IN NUMBER := 0,
  table_name                     IN VARCHAR2 := NULL
)
RETURN COLUMN_RECORDS PIPELINED;

Paramètres

Paramètre Description

catalog_name

Nom du catalogue source. La valeur est en majuscules.

schema_name

(Facultatif)

Nom du schéma de catalogue source.

Valeur par défaut : NULL.

parent_type

(Facultatif)

Type d'objet parent, c'est-à-dire table ou vue.

Valeur par défaut : NULL.

column_name

(Facultatif)

nom de la colonne.

Valeur par défaut : NULL.

conditions

(Facultatif)

Expressions de filtre supplémentaires à l'aide de la syntaxe de lignage.

Valeur par défaut : NULL.

flags

(Facultatif)

Indicateurs pour un contrôle supplémentaire.

La valeur par défaut est 0 (zéro).

result_limit

(Facultatif)

Nombre maximum de lignes à renvoyer.

Valeur par défaut : NULL.

column_flags

(Facultatif)

Indicateurs de colonne, par exemple FETCH_PROPERTIES, FETCH_METADATA.

La valeur par défaut est 0 (zéro).

table_name

(Facultatif)

Nom de la table de catalogue source.

Valeur par défaut : NULL.

Procédure CREATE_EXTERNAL_TABLE

Crée une table externe dans un catalogue.

Syntaxe

PROCEDURE CREATE_EXTERNAL_TABLE
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  storage_link_name              IN VARCHAR2 := NULL,
  file_uri_list                  IN CLOB,
  column_list                    IN CLOB := NULL,
  field_list                     IN CLOB := NULL,
  table_format                   IN CLOB := NULL,
  credential_name                IN VARCHAR2 := NULL,
  replace_if_exists              IN BOOLEAN := FALSE
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue source. La valeur est en majuscules.

schema_name

Nom du schéma de catalogue source.

table_name

Nom de la table de catalogue source.

storage_link_name

(Facultatif)

Nom de la liaison de stockage cloud.

Valeur par défaut : NULL.

file_uri_list

Liste de fichiers relatifs en tant qu'objet CLOB.

column_list

(Facultatif)

Liste de colonnes.

Valeur par défaut : NULL.

field_list

(Facultatif)

Liste de champs.

Valeur par défaut : NULL.

table_format

(Facultatif)

Format ou options de lecture de fichiers externes (CSV, Parquet ou Avro, séparateurs, en-têtes, paramètres de dérivation de schéma, etc.). Il est exprimé en paires clé-valeur JSON.

Valeur par défaut : NULL.

credential_name

Nom des informations d'identification.

Valeur par défaut : NULL.

replace_if_exists

Indique si un objet doit être remplacé s'il existe déjà.

La valeur par défaut est FALSE.

Procédure CREATE_SCHEMA

Crée un schéma dans un catalogue. Vous pouvez également créer le schéma Apache Iceberg dans les catalogues distants.

Syntaxe

PROCEDURE CREATE_SCHEMA
(
  catalog_name          IN VARCHAR2,
  schema_name           IN VARCHAR2,
  schema_definition     IN CLOB := NULL
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue source. La valeur est en majuscules.

schema_name

Nom du schéma de catalogue source.

schema_definition

(Facultatif)

Charge utile de définition de schéma.

Valeur par défaut : NULL.

Procédure DROP_SCHEMA

Cette procédure supprime un schéma d'un catalogue avec tout son contenu.

Syntaxe

PROCEDURE drop_schema
(
  catalog_name 	IN VARCHAR2,
  schema_name 	IN VARCHAR2
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

schema_name:

Nom de schéma à supprimer.

Procédure GET_OBJECTS

Cette procédure extrait tous les objets d'un catalogue.

Syntaxe

FUNCTION get_objects
(
  catalog_name 	IN VARCHAR2,
  schema_name 	IN VARCHAR2 := NULL,
  object_name 	IN VARCHAR2 := NULL,
  conditions 	IN VARCHAR2 := NULL,
  flags 		IN NUMBER := 0,
  result_limit 	IN NUMBER := NULL
)
RETURN catalog_objects PIPELINED;

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

schema_name

Nom de schéma facultatif. La valeur par défaut est NULL.

object_name

Nom d'objet facultatif. La valeur par défaut est NULL.

conditions

Conditions supplémentaires facultatives utilisant la syntaxe de lignage. La valeur par défaut est NULL.

result_limit

Limite de résultats facultative. La valeur par défaut est NULL.

Procédure GET_SCHEMAS

Cette procédure extrait tous les schémas d'un catalogue.

Syntaxe

FUNCTION get_schemas
(
  catalog_name 	IN VARCHAR2,
  schema_name 	IN VARCHAR2 := NULL,
  conditions 	IN VARCHAR2 := NULL,
  flags 		IN NUMBER := 0,
  result_limit 	IN NUMBER := NULL,
  column_flags 	IN NUMBER := 0
)
RETURN catalog_schemas PIPELINED;

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

schema_name

Nom de schéma facultatif. La valeur par défaut est NULL.

conditions

Conditions supplémentaires facultatives utilisant la syntaxe de lignage. La valeur par défaut est NULL.

result_limit

Limite de résultats facultative. La valeur par défaut est NULL.

column_flags

Indicateurs de colonne facultatifs (par exemple, FETCH_PROPERTIES, FETCH_METADATA). La valeur par défaut est 0.

Procédure GET_TABLES

Cette procédure extrait toutes les tables d'un catalogue.

Syntaxe

FUNCTION get_tables
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2 := NULL,
  table_name 		IN VARCHAR2 := NULL,
  conditions 		IN VARCHAR2 := NULL,
  flags 			IN NUMBER := 0,
  result_limit 		IN NUMBER := NULL,
  column_flags 		IN NUMBER := 0
)
RETURN catalog_tables PIPELINED;

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

schema_name

Nom de schéma facultatif. La valeur par défaut est NULL.

table_name

Nom de table facultatif. La valeur par défaut est NULL.

conditions

Conditions supplémentaires facultatives utilisant la syntaxe de lignage. La valeur par défaut est NULL.

result_limit

Limite de résultats facultative. La valeur par défaut est NULL.

column_flags

Indicateurs de colonne facultatifs (par exemple, FETCH_PROPERTIES, FETCH_METADATA). La valeur par défaut est 0.

Remarque

  • Les types RECORD décrivent les données structurées avec des champs nommés dans les bases de données.

  • Vous devez interroger le schéma d'informations de la base de données, les catalogues système ou utiliser des outils d'introspection de base de données pour voir la structure des types RECORD.

Procédure GET_TABLE

Extrait les informations détaillées d'une table spécifique d'un catalogue en tant qu'enregistrement, avec des options permettant de personnaliser les considérations de sortie et de mise en mémoire cache.

Syntaxe

PROCEDURE GET_TABLE
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  table_info                     OUT NOCOPY catalog_table,
  options                        IN CLOB := NULL,
  flags                          IN NUMBER := 0,
  column_flags                   IN NUMBER := 0,
  prev_gen_sql                   IN CLOB := NULL,
  prev_ts                        IN TIMESTAMP WITH TIME ZONE := NULL
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue source. La valeur est en majuscules.

schema_name

Nom du schéma de catalogue source.

table_name

Nom de la table de catalogue source.

options

Options de génération en tant qu'objet JSON, par exemple distinct, rowLimit, select, orderBy et directive.

Valeur par défaut : NULL.

flags

(Facultatif)

Indicateurs pour un contrôle supplémentaire.

La valeur par défaut est 0 (zéro).

column_flags

(Facultatif)

Indicateurs de colonne, par exemple FETCH_PROPERTIES, FETCH_METADATA.

La valeur par défaut est 0 (zéro).

prev_gen_sql

Instruction SELECT générée précédemment pour le traitement incrémentiel, si elle est connue.

Valeur par défaut : NULL.

prev_ts

Horodatage de la génération précédente, le cas échéant.

Valeur par défaut : NULL.

Fonction GET_TABLE

Extrait les informations détaillées d'une table spécifique au format JSON en tant qu'objet CLOB (Character Large Object).

Syntaxe

FUNCTION GET_TABLE
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  options                        IN CLOB := NULL,
  flags                          IN NUMBER := 0,
  column_flags                   IN NUMBER := 0,
  prev_gen_sql                   IN CLOB := NULL,
  prev_ts                        IN TIMESTAMP WITH TIME ZONE := NULL
)
RETURN CLOB;

Paramètres

Paramètre Description

catalog_name

Nom du catalogue source. La valeur est en majuscules.

schema_name

Nom du schéma de catalogue source.

table_name

Nom de la table de catalogue source.

options

Options de génération en tant qu'objet JSON, par exemple distinct, rowLimit, select, orderBy et directive.

Valeur par défaut : NULL.

flags

(Facultatif)

Indicateurs pour un contrôle supplémentaire.

La valeur par défaut est 0 (zéro).

column_flags

(Facultatif)

Indicateurs de colonne, par exemple FETCH_PROPERTIES, FETCH_METADATA.

La valeur par défaut est 0 (zéro).

prev_gen_sql

Instruction SELECT générée précédemment pour le traitement incrémentiel, si elle est connue.

Valeur par défaut : NULL.

prev_ts

Horodatage de la génération précédente, le cas échéant.

Valeur par défaut : NULL.

Procédure DROP_TABLE

Cette procédure supprime une table d'un catalogue.

Syntaxe

PROCEDURE drop_table
(
  catalog_name 	IN VARCHAR2,
  schema_name 	IN VARCHAR2,
  table_name 	IN VARCHAR2
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

schema_name

Nom du schéma.

table_name

Nom de la table.

Procédure GENERATE_TABLE_SELECT (surchargée)

Cette procédure génère une instruction SELECT pour une table logique.

Syntaxe

PROCEDURE generate_table_select
(
  catalog_name 		IN VARCHAR2,
  schema_name 		IN VARCHAR2,
  table_name 		IN VARCHAR2,
  stmt 				IN OUT NOCOPY CLOB,
  options 			IN CLOB := NULL,
  prev_gen_sql 		IN CLOB := NULL,
  prev_ts 			IN TIMESTAMP WITH TIME ZONE := NULL
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

schema_name

Nom du schéma.

table_name

Nom de la table.

stmt

L'instruction SELECT générée en sortie.

options

Options de génération en tant qu'objet JSON (par exemple, distinct, rowLimit, select, orderBy). La valeur par défaut est NULL.

prev_gen_sql

Instruction SELECT générée précédemment, si elle est connue. La valeur par défaut est NULL.

prev_ts

Horodatage de la génération précédente, le cas échéant. La valeur par défaut est NULL.

Syntaxe

FUNCTION generate_table_select
(
  catalog_name 	IN VARCHAR2,
  schema_name 	IN VARCHAR2,
  table_name 	IN VARCHAR2,
  options 		IN CLOB := NULL,
  prev_gen_sql 	IN CLOB := NULL,
  prev_ts 		IN TIMESTAMP WITH TIME ZONE := NULL
)
RETURN CLOB;

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

schema_name

Nom du schéma.

table_name

Nom de la table.

stmt

L'instruction SELECT générée en sortie.

options

Options de génération en tant qu'objet JSON (par exemple, distinct, rowLimit, select, orderBy). La valeur par défaut est NULL.

prev_gen_sql

Instruction SELECT générée précédemment, si elle est connue. La valeur par défaut est NULL.

prev_ts

Horodatage de la génération précédente, le cas échéant. La valeur par défaut est NULL.

Procédure OPEN_TABLE_CURSOR

Cette procédure ouvre un curseur qui renvoie les données d'une table logique.

Syntaxe

PROCEDURE open_table_cursor
(
  catalog_name 	IN VARCHAR2,
  schema_name 	IN VARCHAR2,
  table_name 	IN VARCHAR2,
  table_cursor 	IN OUT NOCOPY SYS_REFCURSOR,
  options 		IN CLOB := NULL
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

schema_name

Nom de schéma facultatif. La valeur par défaut est NULL.

table_name

Nom de table facultatif. La valeur par défaut est NULL.

table_cursor

Curseur permettant de renvoyer des données.

options

Génère des options en tant qu'objet JSON (par exemple, rowLimit, select, orderBy). La valeur par défaut est NULL.

Procédure FLUSH_CATALOG_CACHE

Cette procédure vide le cache de métadonnées du catalogue,

Syntaxe

PROCEDURE flush_catalog_cache
(
  catalog_name 	IN VARCHAR2,
  auto_commit	IN BOOLEAN := TRUE
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

auto_commit

Indique si les modifications doivent être validées automatiquement. La valeur par défaut est TRUE.

Procédure PREFILL_CATALOG_CACHE

Cette procédure remplit le cache du catalogue spécifié avec les données actuelles.

Syntaxe

PROCEDURE prefill_catalog_cache
(
  catalog_name 	IN VARCHAR2,
  schema_name 	IN VARCHAR2 := NULL,
  auto_commit 	IN BOOLEAN := TRUE
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

schema_name

Nom du schéma.

auto_commit

Indique si les modifications doivent être validées automatiquement. La valeur par défaut est TRUE.

Procédure CREATE_SYNCHRONIZED_SCHEMAS

Cette procédure crée des schémas de base de données locaux synchronisés avec des définitions de catalogue distant.

Syntaxe

PROCEDURE create_synchronized_schemas
(
  catalog_name IN VARCHAR2,
  schema_names IN VARCHAR2 := NULL,
  restrictions IN CLOB := NULL
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

schema_name

Liste de noms de schéma séparés par des virgules (entre guillemets ou sans guillemets). La valeur par défaut est NULL pour synchroniser tous les schémas.

restrictions

Document JSON indiquant la portée des entités de catalogue. La valeur par défaut est NULL.

Procédure DROP_SYNCHRONIZED_SCHEMAS

Cette procédure supprime un ou plusieurs schémas synchronisés.

Syntaxe

PROCEDURE drop_synchronized_schemas
(
  catalog_name IN VARCHAR2,
  schema_names IN VARCHAR2 := NULL,
  restrictions IN CLOB := NULL
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

schema_name

Liste de noms de schéma séparés par des virgules (entre guillemets ou sans guillemets). La valeur par défaut est NULL pour synchroniser tous les schémas.

restrictions

Document JSON indiquant la portée des entités de catalogue. La valeur par défaut est NULL.

Procédure UPDATE_SYNCHRONIZED_SCHEMA_PROPERTY

Cette procédure met à jour une propriété de schémas synchronisés.

Syntaxe

PROCEDURE update_synchronized_schema_property
(
  catalog_name 	IN VARCHAR2,
  property_name IN VARCHAR2,
  new_value 	IN CLOB
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

property_name

Nom de propriété à mettre à jour.

new_value

Nouvelle valeur en tant qu'OBCL.

Procédure SYNCHRONIZE_SHARED_CATALOGS

Gérer les catalogues en fonction des partages qui ne sont plus disponibles.

Syntaxe

PROCEDURE SYNCHRONIZE_SHARED_CATALOGS
(
  provider_id                    IN NUMBER := NULL,
  remove_unavailable             IN BOOLEAN := TRUE
);

Paramètres

Paramètre Description
provider_id

(Facultatif)

Identifie la portée de la synchronisation. Les modifications sont limitées à l'ID de fournisseur de partage spécifié. Si NULL, il synchronise tous les fournisseurs de partage enregistrés, y compris les partages expirés.

Valeur par défaut : NULL.

remove_unavailable

Détermine l'action sur les catalogues en fonction de la disponibilité du partage.

  • TRUE : démonte les objets pour les partages supprimés ou non disponibles.

  • FALSE : désactive les objets si les partages ne sont pas disponibles.

La valeur par défaut est TRUE.

Procédure CREATE_SYNCHRONIZED_VIEWS

Crée des vues sur les tables de catalogue pour la définition des restrictions.

Syntaxe

PROCEDURE CREATE_SYNCHRONIZED_VIEWS
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2 := NULL,
  target_schema                  IN VARCHAR2 := NULL,
  table_names                    IN VARCHAR2 := NULL,
  view_prefix                    IN VARCHAR2 := NULL,
  replace_existing               IN BOOLEAN := FALSE,
  ignore_errors                  IN BOOLEAN := TRUE
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue source. La valeur est en majuscules.

schema_name

Nom du schéma de catalogue source.

Valeur par défaut : NULL.

target_schema

Nom du schéma cible.

Valeur par défaut : NULL.

table_names

Liste des noms de table séparés par des virgules si des tables spécifiques sont ciblées.

Valeur par défaut : NULL.

view_prefix

Chaîne à ajouter au début de chaque nom de vue généré.

Valeur par défaut : NULL.

replace_existing

Indique si un objet doit être remplacé s'il existe déjà.

La valeur par défaut est FALSE.

ignore_errors

Indique si les erreurs doivent être ignorées et si les objets restants doivent être traités.

La valeur par défaut est TRUE.

Procédure COPY_TABLE_PROPERTIES

Copie les propriétés de table et éventuellement les propriétés de colonne d'une table source vers une table cible dans les catalogues et les schémas, avec des options permettant de sélectionner un jeu de propriétés et d'indiquer des mappings de changement de nom de colonne.

Syntaxe

PROCEDURE COPY_TABLE_PROPERTIES
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  target_catalog_name            IN VARCHAR2 := DEFAULT_CATALOG,
  target_schema_name             IN VARCHAR2 := NULL,
  target_table_name              IN VARCHAR2 := NULL,
  properties                     IN VARCHAR2 := PROP_CUSTOM,
  copy_column_props              IN BOOLEAN := TRUE,
  renamed_columns                IN CLOB := NULL
);

Paramètres

Paramètre Description
catalog_name

Nom du catalogue source. La valeur est en majuscules.

schema_name

Nom du schéma de catalogue source.

table_name

Nom de la table de catalogue source.

target_catalog_name

Nom du catalogue cible.

La valeur par défaut est DEFAULT_CATALOG.

target_schema_name

Nom du schéma cible.

Valeur par défaut : NULL.

target_table_name

Nom de la table de catalogue cible.

Valeur par défaut : NULL.

properties

Propriétés à copier, par exemple CUSTOM:prop_x. La valeur par défaut est PROP_CUSTOM.

copy_column_props

Indique si les propriétés personnalisées de colonne doivent être copiées.

La valeur par défaut est TRUE.

renamed_columns

Correspondance JSON des colonnes cible renommées, par exemple {"source_col":"target_col"}.

Valeur par défaut : NULL.

Procédure GRANT_TO_RECIPIENT

Cette procédure permet d'accorder l'accès à un destinataire de partage spécifique sur un catalogue.

Syntaxe

PROCEDURE grant_to_recipient
(
  catalog_name 		IN VARCHAR2,
  recipient_name 	IN VARCHAR2
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

recipient_name

Nom du destinataire du partage (créé par DBMS_SHARE.CREATE_SHARE_RECIPIENT).

Procédure REVOKE_FROM_RECIPIENT

Cette procédure révoque l'accès d'un destinataire spécifique à un catalogue.

Syntaxe

PROCEDURE revoke_from_recipient
(
  catalog_name 		IN VARCHAR2,
  recipient_name 	IN VARCHAR2,
  owner 			IN VARCHAR2 := NULL
);	

Paramètres

Paramètre Description

catalog_name

Nom du catalogue existant. Elle sera convertie en majuscules.

recipient_name

Nom du destinataire du partage (créé par DBMS_SHARE.CREATE_SHARE_RECIPIENT).

owner

Propriétaire du catalogue et du destinataire. La valeur par défaut est NULL.

Procédure CLEAR_CATALOG_EVENTS

Extrait les informations détaillées d'une table spécifique d'un catalogue en tant qu'enregistrement, avec des options permettant de personnaliser les considérations de sortie et de mise en mémoire cache.

Syntaxe

PROCEDURE CLEAR_CATALOG_EVENTS
(
  catalog_name                   IN VARCHAR2,
  from_time                      IN TIMESTAMP WITH TIME ZONE := NULL,
  to_time                        IN TIMESTAMP WITH TIME ZONE := NULL
);

Paramètres

Paramètre Description

catalog_name

Nom du catalogue source. La valeur est en majuscules.

from_time

Facultatif

Heure de début de la plage d'événements à effacer.

Valeur par défaut : NULL.

to_time

Facultatif

Heure de fin de la plage d'événements à effacer.

Valeur par défaut : NULL.

Procédure CREATE_ICEBERG_TABLE

Crée une nouvelle table Iceberg dans un schéma spécifié d'un catalogue, renvoyant les métadonnées résultantes.

Syntaxe

PROCEDURE CREATE_ICEBERG_TABLE
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  table_definition               IN CLOB,
  out_metadata                   OUT NOCOPY CLOB
);

Paramètres

Paramètre Description
catalog_name

Nom du catalogue source. La valeur est en majuscules.

schema_name

Nom du schéma de catalogue source.

table_name

Nom de la nouvelle table.

table_definition

La définition de la table en tant qu'objet CLOB.

out_metadata

Les métadonnées de la table résultante suivant la sortie.

Procédure ADD_ICEBERG_SNAPSHOT

Ajoute un instantané à une table Iceberg pour représenter les modifications de données, y compris les métadonnées détaillées et les paramètres facultatifs pour le suivi du lignage et du contenu.

Syntaxe

PROCEDURE ADD_ICEBERG_SNAPSHOT
(
  catalog_name                   IN VARCHAR2,
  schema_name                    IN VARCHAR2,
  table_name                     IN VARCHAR2,
  new_snapshot_id                IN NUMBER,
  new_timestamp                  TIMESTAMP WITH TIME ZONE,
  new_manifest_list              IN VARCHAR2,
  new_summary                    IN CLOB := NULL,
  new_parent_snapshot_id         IN NUMBER := NULL,
  new_sequence_number            IN NUMBER := NULL,
  new_first_row_id               IN NUMBER := NULL,
  new_added_row_count            IN NUMBER := NULL,
  new_schema_id                  IN NUMBER := NULL,
  requirements                   IN CLOB := NULL,
  out_metadata                   OUT NOCOPY CLOB
);

Paramètres

Paramètre Description
catalog_name

Nom du catalogue source. La valeur est en majuscules.

schema_name

Nom du schéma de catalogue source.

table_name

Nom de la nouvelle table.

new_snapshot_id

Identificateur unique du nouveau cliché.

new_timestamp

Horodatage de la création du cliché.

new_manifest_list

Emplacement, chemin ou URI du fichier de liste de manifestes.

new_summary

Récapitulatif des métadonnées de l'instantané qui inclut au moins un champ "opération".

new_parent_snapshot_id

ID du parent de cet instantané. Cela ne s'applique pas aux instantanés root.

new_sequence_number

Numéro incrémentiel permettant de suivre l'ordre des modifications de table.

new_first_row_id

ID ligne de début affecté à la première ligne du premier fichier de données de l'instantané.

new_added_row_count

Nombre de lignes ajoutées dans le cliché.

new_schema_id

ID du schéma de table actif lors de la création du cliché.

requirements

Conditions préalables à la validation, sous forme de tableau JSON.

out_metadata

Les métadonnées de la table résultante suivant la sortie.