Référence de l'API Java pour le Driver JDBC Databricks

Cet article fournit une documentation de référence pour l'Driver JDBC Databricks, version 3 et supérieures.

Interface IDatabricksConnection

Décrit les méthodes pour récupérer les descripteurs de connexion et d'exécution d'instructions.

package: com.databricks.jdbc.api

getStatement
IDatabricksStatement getStatement(String statementId) throws SQLException Renvoie un handle pour un ID d’instruction donné. Renvoie : Une IDatabricksStatement pour gérer une exécution existante.

getStatement
IDatabricksStatement getStatement(String statementId) throws SQLException Renvoie un handle pour un ID d’instruction donné. Renvoie : Une IDatabricksStatement pour gérer une exécution existante.

getConnectionId
String getConnectionId() throws SQLException Renvoie un descripteur pour la connexion de session. Renvoie : Une chaîne qui représente la connexion pour la session sous-jacente de l'exécution.

getConnectionId
String getConnectionId() throws SQLException Renvoie un descripteur pour la connexion de session. Renvoie : Une chaîne qui représente la connexion pour la session sous-jacente de l'exécution.

Interface IDatabricksDriver

Décrit les méthodes pour gérer la connexion du Driver.

package: com.databricks.client.jdbc

com.databricks.client.jdbc.Driver étend com.databricks.client.jdbc.IDatabricksDriver et java.sql.Driver.

Fermer la connexion
void closeConnection(String url, Properties info, String connectionId) throws SQLException Ferme la connexion pour l'ID de connexion et l'URL de connexion JDBC spécifiés. Renvoie : Aucun

Fermer la connexion
void closeConnection(String url, Properties info, String connectionId) throws SQLException Ferme la connexion pour l'ID de connexion et l'URL de connexion JDBC spécifiés. Renvoie : Aucun

Interface IDatabricksResultSet

Décrit les méthodes pour récupérer les résultats d'une query asynchrone.

package: com.databricks.jdbc.api

getExecutionStatus
IExecutionStatus getExecutionStatus() throws SQLException Renvoie l'état de l'exécution. Renvoie : Un IExecutionStatus qui représente le statut de l’exécution

getExecutionStatus
IExecutionStatus getExecutionStatus() throws SQLException Renvoie l'état de l'exécution. Renvoie : Un IExecutionStatus qui représente le statut de l’exécution

getStatementId
String getStatementId() throws SQLException Renvoie l'ID de l'instruction associée à l'exécution asynchrone. Renvoie : Une chaîne de caractères qui est l'ID de l'exécution

getStatementId
String getStatementId() throws SQLException Renvoie l'ID de l'instruction associée à l'exécution asynchrone. Renvoie : Une chaîne de caractères qui est l'ID de l'exécution

interface IDatabricksStatement

Décrit les méthodes permettant d’exécuter et de gérer une query asynchrone.

package: com.databricks.jdbc.api

executeAsync
ResultSet executeAsync(String sql) throws SQLException Exécute une commande SQL en mode asynchrone. Paramètres : sql - la commande à exécuter. Renvoie : Un ResultSet qui représente les résultats du SQL exécuté

executeAsync
ResultSet executeAsync(String sql) throws SQLException Exécute une commande SQL en mode asynchrone. Paramètres : sql - la commande à exécuter. Renvoie : Un ResultSet qui représente les résultats du SQL exécuté

getExecutionResult
ResultSet getExecutionResult() throws SQLException Récupère un état et une réponse pour une commande SQL déjà exécutée, et renvoie une erreur si aucune commande n'a été exécutée. Cette méthode peut être appelée plusieurs fois pour interroger l'état d'exécution. Renvoie : Un ResultSet qui représente les résultats du SQL exécuté

getExecutionResult
ResultSet getExecutionResult() throws SQLException Récupère un état et une réponse pour une commande SQL déjà exécutée, et renvoie une erreur si aucune commande n'a été exécutée. Cette méthode peut être appelée plusieurs fois pour interroger l'état d'exécution. Renvoie : Un ResultSet qui représente les résultats du SQL exécuté

interface IDatabricksVolumeClient

Décrit les méthodes de gestion des fichiers dans les volumes Unity Catalog.

package: com.databricks.jdbc.api

prefixExists

boolean prefixExists(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException Détermine si un préfixe spécifique (structure de dossier) existe dans le volume Unity Catalog. Le préfixe doit faire partie du nom de fichier. Paramètres : catalog - le nom du catalogue du stockage cloud. schema - le nom du schéma du stockage cloud. volume - le nom de volume Unity Catalog du stockage cloud. prefix – le préfixe à vérifier son existence, ainsi que le chemin relatif à partir du volume en tant que répertoire racine. caseSensitive - si la vérification doit être sensible à la casse ou non. Renvoie : Un booléen indiquant si le préfixe existe ou non.

prefixExists

boolean prefixExists(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException Détermine si un préfixe spécifique (structure de dossier) existe dans le volume Unity Catalog. Le préfixe doit faire partie du nom de fichier. Paramètres : catalog - le nom du catalogue du stockage cloud. schema - le nom du schéma du stockage cloud. volume - le nom de volume Unity Catalog du stockage cloud. prefix – le préfixe à vérifier son existence, ainsi que le chemin relatif à partir du volume en tant que répertoire racine. caseSensitive - si la vérification doit être sensible à la casse ou non. Renvoie : Un booléen indiquant si le préfixe existe ou non.

l'objet existe

boolean objectExists(String catalog, String schema, String volume, String objectPath, boolean caseSensitive) throws SQLException Détermine si un objet spécifique (fichier) existe dans le volume Unity Catalog. L’objet doit correspondre exactement au nom de fichier. Paramètres : catalog - le nom du catalogue du stockage cloud. schema - le nom du schéma du stockage cloud. volume - le nom de volume Unity Catalog du stockage cloud. objectPath - le chemin d'accès à l'objet (fichier) à partir du volume en tant que répertoire racine pour vérifier son existence dans le volume (dans n'importe quel sous-dossier). caseSensitive - un booléen indiquant si la vérification doit être sensible à la casse ou non. Renvoie : Un booléen indiquant si l'objet existe ou non.

l'objet existe

boolean objectExists(String catalog, String schema, String volume, String objectPath, boolean caseSensitive) throws SQLException Détermine si un objet spécifique (fichier) existe dans le volume Unity Catalog. L’objet doit correspondre exactement au nom de fichier. Paramètres : catalog - le nom du catalogue du stockage cloud. schema - le nom du schéma du stockage cloud. volume - le nom de volume Unity Catalog du stockage cloud. objectPath - le chemin d'accès à l'objet (fichier) à partir du volume en tant que répertoire racine pour vérifier son existence dans le volume (dans n'importe quel sous-dossier). caseSensitive - un booléen indiquant si la vérification doit être sensible à la casse ou non. Renvoie : Un booléen indiquant si l'objet existe ou non.

volumeExists

boolean volumeExists(String catalog, String schema, String volumeName, boolean caseSensitive) throws SQLException Détermine si un volume spécifique existe dans le catalogue et le schéma donnés. Le volume doit correspondre exactement au nom du volume. Paramètres : catalog - le nom du catalogue du stockage cloud. schema - le nom du schéma du stockage cloud. volumeName - le nom du volume dont il faut vérifier l'existence. caseSensitive un booléen indiquant si la vérification doit être sensible à la casse ou non. Renvoie : Un booléen indiquant si le volume existe ou non.

volumeExists

boolean volumeExists(String catalog, String schema, String volumeName, boolean caseSensitive) throws SQLException Détermine si un volume spécifique existe dans le catalogue et le schéma donnés. Le volume doit correspondre exactement au nom du volume. Paramètres : catalog - le nom du catalogue du stockage cloud. schema - le nom du schéma du stockage cloud. volumeName - le nom du volume dont il faut vérifier l'existence. caseSensitive un booléen indiquant si la vérification doit être sensible à la casse ou non. Renvoie : Un booléen indiquant si le volume existe ou non.

listObjects

List<String> listObjects(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException Retourne la liste de tous les noms de fichiers dans le volume Unity Catalog qui start avec un préfixe spécifié. Le préfixe doit faire partie du chemin d'accès au fichier à partir du volume, en tant que racine. Paramètres : catalog - le nom du catalogue du stockage cloud. schema - le nom du schéma du stockage cloud. volume - le nom du volume UC du stockage cloud. prefix - le préfixe des noms de fichiers à lister. Cela inclut le chemin relatif à partir du volume comme répertoire racine. caseSensitive - un booléen indiquant si la vérification doit être sensible à la casse ou non. Renvoie : Une liste de chaînes indiquant les noms de fichiers qui start par le préfixe spécifié.

listObjects

List<String> listObjects(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException Retourne la liste de tous les noms de fichiers dans le volume Unity Catalog qui start avec un préfixe spécifié. Le préfixe doit faire partie du chemin d'accès au fichier à partir du volume, en tant que racine. Paramètres : catalog - le nom du catalogue du stockage cloud. schema - le nom du schéma du stockage cloud. volume - le nom du volume UC du stockage cloud. prefix - le préfixe des noms de fichiers à lister. Cela inclut le chemin relatif à partir du volume comme répertoire racine. caseSensitive - un booléen indiquant si la vérification doit être sensible à la casse ou non. Renvoie : Une liste de chaînes indiquant les noms de fichiers qui start par le préfixe spécifié.

getObject (fichier)

boolean getObject(String catalog, String schema, String volume, String objectPath, String localPath) throws SQLException Récupère un objet (fichier) du volume Unity Catalog et le stocke dans le chemin local spécifié. Paramètres : catalog - le nom du catalogue du stockage cloud. schema - le nom du schéma du stockage cloud. volume - le nom du volume UC du stockage cloud. objectPath - le chemin de l'objet (fichier) depuis le volume comme répertoire racine. localPath - le chemin local où les données récupérées doivent être stockées. Renvoie : Une valeur booléenne indiquant l'état de l'opération GET.

getObject (fichier)

boolean getObject(String catalog, String schema, String volume, String objectPath, String localPath) throws SQLException Récupère un objet (fichier) du volume Unity Catalog et le stocke dans le chemin local spécifié. Paramètres : catalog - le nom du catalogue du stockage cloud. schema - le nom du schéma du stockage cloud. volume - le nom du volume UC du stockage cloud. objectPath - le chemin de l'objet (fichier) depuis le volume comme répertoire racine. localPath - le chemin local où les données récupérées doivent être stockées. Renvoie : Une valeur booléenne indiquant l'état de l'opération GET.

getObject (Stream)

InputStreamEntity getObject(String catalog, String schema, String volume, String objectPath) throws SQLException Récupère un objet en tant que Stream à partir du volume Unity Catalog. Paramètres : catalog - le nom du catalogue du stockage cloud. schema - le nom du schéma du stockage cloud. volume - le nom du volume UC du stockage cloud. objectPath - le chemin de l'objet (fichier) depuis le volume comme répertoire racine. Renvoie : Une instance de l'entité de flux de Stream.

getObject (Stream)

InputStreamEntity getObject(String catalog, String schema, String volume, String objectPath) throws SQLException Récupère un objet en tant que Stream à partir du volume Unity Catalog. Paramètres : catalog - le nom du catalogue du stockage cloud. schema - le nom du schéma du stockage cloud. volume - le nom du volume UC du stockage cloud. objectPath - le chemin de l'objet (fichier) depuis le volume comme répertoire racine. Renvoie : Une instance de l'entité de flux de Stream.

putObject (fichier)

boolean putObject(String catalog, String schema, String volume, String objectPath, String localPath, boolean toOverwrite) throws SQLException upload les données d'un chemin local vers un chemin spécifié dans un volume Unity Catalog. Paramètres : catalog - le nom du catalogue du stockage cloud. schema - le nom du schéma du stockage cloud. volume - le nom du volume UC du stockage cloud. objectPath le chemin de destination où l'objet (fichier) doit être upload à partir du `volume` en tant que répertoire racine. localPath le chemin d'accès local depuis lequel les données doivent être upload. toOverwrite un booléen indiquant s'il faut écraser l'objet s'il existe déjà. Renvoie : Une valeur booléenne indiquant l'état de l'opération PUT.

putObject (fichier)

boolean putObject(String catalog, String schema, String volume, String objectPath, String localPath, boolean toOverwrite) throws SQLException upload les données d'un chemin local vers un chemin spécifié dans un volume Unity Catalog. Paramètres : catalog - le nom du catalogue du stockage cloud. schema - le nom du schéma du stockage cloud. volume - le nom du volume UC du stockage cloud. objectPath le chemin de destination où l'objet (fichier) doit être upload à partir du `volume` en tant que répertoire racine. localPath le chemin d'accès local depuis lequel les données doivent être upload. toOverwrite un booléen indiquant s'il faut écraser l'objet s'il existe déjà. Renvoie : Une valeur booléenne indiquant l'état de l'opération PUT.

putObject (Stream)

boolean putObject(String catalog, String schema, String volume, String objectPath, InputStream inputStream, long contentLength, boolean toOverwrite) throws SQLException Télécharge les données d'un stream d'entrée vers un chemin d'accès spécifié dans un volume Unity Catalog. Paramètres : catalog - le nom du catalogue du stockage cloud. schema - le nom du schéma du stockage cloud. volume - le nom du volume UC du stockage cloud. objectPath - le chemin de destination où l'objet (fichier) doit être upload à partir du volume en tant que répertoire racine. inputStream - le stream d'entrée à partir duquel les données doivent être upload. contentLength - la longueur du Stream d'entrée. toOverwrite un booléen indiquant s'il faut écraser l'objet s'il existe déjà. Renvoie : Une valeur booléenne indiquant l'état de l'opération PUT.

putObject (Stream)

boolean putObject(String catalog, String schema, String volume, String objectPath, InputStream inputStream, long contentLength, boolean toOverwrite) throws SQLException Télécharge les données d'un stream d'entrée vers un chemin d'accès spécifié dans un volume Unity Catalog. Paramètres : catalog - le nom du catalogue du stockage cloud. schema - le nom du schéma du stockage cloud. volume - le nom du volume UC du stockage cloud. objectPath - le chemin de destination où l'objet (fichier) doit être upload à partir du volume en tant que répertoire racine. inputStream - le stream d'entrée à partir duquel les données doivent être upload. contentLength - la longueur du Stream d'entrée. toOverwrite un booléen indiquant s'il faut écraser l'objet s'il existe déjà. Renvoie : Une valeur booléenne indiquant l'état de l'opération PUT.

deleteObject

boolean deleteObject(String catalog, String schema, String volume, String objectPath) throws SQLException Supprime un objet d'un chemin spécifié dans un volume Unity Catalog. Paramètres : catalog - le nom du catalogue du stockage cloud. schema - le nom du schéma du stockage cloud. volume - le nom du volume UC du stockage cloud. objectPath - le chemin de l'objet (fichier) à partir du volume en tant que répertoire racine à supprimer. Renvoie : Une valeur booléenne indiquant l'état de l'opération DELETE.

deleteObject

boolean deleteObject(String catalog, String schema, String volume, String objectPath) throws SQLException Supprime un objet d'un chemin spécifié dans un volume Unity Catalog. Paramètres : catalog - le nom du catalogue du stockage cloud. schema - le nom du schéma du stockage cloud. volume - le nom du volume UC du stockage cloud. objectPath - le chemin de l'objet (fichier) à partir du volume en tant que répertoire racine à supprimer. Renvoie : Une valeur booléenne indiquant l'état de l'opération DELETE.

Interface IDatabricksGeospatial

Décrit les méthodes pour travailler avec les types de données géospatiales (GEOMETRY et GEOGRAPHY). Cette interface est étendue par les interfaces marqueurs IGeometry et IGeography pour les objets géospatiaux spécifiques au type.

package: com.databricks.jdbc.api

getWKT
String getWKT() Renvoie la représentation Well-Known Text (WKT) de l'objet géospatial. Renvoie : Une chaîne contenant la représentation WKT sans préfixe SRID.

getWKT
String getWKT() Renvoie la représentation Well-Known Text (WKT) de l'objet géospatial. Renvoie : Une chaîne contenant la représentation WKT sans préfixe SRID.

getWKB
byte[] getWKB() Renvoie la représentation binaire bien connue (WKB) conforme à l'OGC de l'objet géospatial. Renvoie : Un tableau d'octets contenant les données WKB.

getWKB
byte[] getWKB() Renvoie la représentation binaire bien connue (WKB) conforme à l'OGC de l'objet géospatial. Renvoie : Un tableau d'octets contenant les données WKB.

getSRID
int getSRID() Renvoie l'identifiant du système de référence spatiale (SRID) de l'objet géospatial. Renvoie : Un entier représentant la valeur SRID (0 si non spécifiée).

getSRID
int getSRID() Renvoie l'identifiant du système de référence spatiale (SRID) de l'objet géospatial. Renvoie : Un entier représentant la valeur SRID (0 si non spécifiée).

Obtenir le type
String getType() Renvoie le nom du type géospatial. Renvoie : Une chaîne de caractères qui est soit GEOMETRY soit GEOGRAPHY.

Obtenir le type
String getType() Renvoie le nom du type géospatial. Renvoie : Une chaîne de caractères qui est soit GEOMETRY soit GEOGRAPHY.

Énumération ExecutionState

Contient les états d'une query asynchrone en cours d'exécution.

package: com.databricks.jdbc.api

RUNNING	L'instruction s'exécute sur le serveur
PENDING	L'instruction n'a pas encore été exécutée sur le serveur
SUCCEEDED	L'instruction a été exécutée avec succès
FAILED	L'exécution de l'instruction a échoué.
ABORTED	La déclaration a été annulée.
CLOSED	La déclaration a été clôturée.

RUNNING	L'instruction s'exécute sur le serveur
PENDING	L'instruction n'a pas encore été exécutée sur le serveur
SUCCEEDED	L'instruction a été exécutée avec succès
FAILED	L'exécution de l'instruction a échoué.
ABORTED	La déclaration a été annulée.
CLOSED	La déclaration a été clôturée.

Interface IExecutionStatus

Décrit les méthodes pour récupérer le statut d'une requête asynchrone.

package: com.databricks.jdbc.api

getExecutionState
ExecutionState getExecutionState() throws SQLException Renvoie l'état du statut d'exécution. Renvoie : Un État d'exécution qui représente l'état de l'exécution

getExecutionState
ExecutionState getExecutionState() throws SQLException Renvoie l'état du statut d'exécution. Renvoie : Un État d'exécution qui représente l'état de l'exécution

getSqlState
String getSqlState() throws SQLException S'il est défini, renvoie le code SQLState pour un statut d'échec. Renvoie : Une Chaîne qui est le code SQLState

getSqlState
String getSqlState() throws SQLException S'il est défini, renvoie le code SQLState pour un statut d'échec. Renvoie : Une Chaîne qui est le code SQLState

getErrorMessage
String getErrorMessage() throws SQLException Renvoie le message d'erreur d'une exécution ayant échoué. Renvoie : Une chaîne de caractères qui correspond au message d'erreur.

getErrorMessage
String getErrorMessage() throws SQLException Renvoie le message d'erreur d'une exécution ayant échoué. Renvoie : Une chaîne de caractères qui correspond au message d'erreur.