Partager via

Informations de référence sur l’API Java pour le pilote JDBC Databricks

Cet article fournit une documentation de référence sur l’API pour le pilote JDBC Databricks, version 3 et ultérieure.

Interface IDatabricksConnection

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

Colis: com.databricks.jdbc.api

getStatement
IDatabricksStatement getStatement(String statementId) throws SQLException
Renvoie un descripteur pour un ID d’instruction donnée
Retours :
IDatabricksStatement pour gérer une exécution existante.
getConnectionId
String getConnectionId() throws SQLException
Renvoie un descripteur pour la connexion de session.
Retours :
Chaîne qui représente la connexion pour la session sous-jacente de l’exécution.

Interface IDatabricksDriver

Décrit les méthodes de gestion de la connexion du pilote.

Colis: com.databricks.client.jdbc

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

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

Interface IDatabricksResultSet

Décrit les méthodes permettant de récupérer les résultats d’une requête asynchrone.

Colis: com.databricks.jdbc.api

getExecutionStatus
IExecutionStatus getExecutionStatus() throws SQLException
Renvoie l’état de l’exécution.
Retours :
IExecutionStatus qui représente l’état de l’exécution
getStatementId
String getStatementId() throws SQLException
Renvoie l’ID d’instruction associé à l’exécution en mode asynchrone.
Retours :
Chaîne qui correspond à l’ID d’instruction de l’exécution.

Interface IDatabricksStatement

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

Colis: com.databricks.jdbc.api

executeAsync
ResultSet executeAsync(String sql) throws SQLException
Exécute une commande SQL en mode asynchrone.
Paramètres :
  • sql - commande à exécuter.

Retours :
Un ResultSet qui représente les résultats de la requête SQL exécutée.
getExecutionResult
ResultSet getExecutionResult() throws SQLException
Récupère un état et une réponse pour une commande SQL déjà exécutée et génère 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.
Retours :
Un ResultSet qui représente les résultats de la requête SQL exécutée.

Interface IDatabricksVolumeClient

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

Colis: com.databricks.jdbc.api

préfixeExiste
boolean prefixExists(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException
Détermine si un préfixe spécifique (structure de type dossier) existe dans le volume catalogue Unity. Le préfixe doit faire partie du nom de fichier.
Paramètres :
  • catalog - nom du catalogue du stockage cloud.
  • schema - nom du schéma du stockage cloud.
  • volume - nom du volume du stockage cloud dans le catalogue Unity.
  • prefix - préfixe permettant de vérifier l’existence ainsi que le chemin d’accès relatif du volume en tant que répertoire racine.
  • caseSensitive – Indique si la vérification doit être sensible à la casse.

Retours :
Valeur booléenne indiquant si le préfixe existe ou non.
objectExists
boolean objectExists(String catalog, String schema, String volume, String objectPath, boolean caseSensitive) throws SQLException
Détermine si un objet (fichier) spécifique existe dans le volume catalogue Unity. L’objet doit correspondre exactement au nom du fichier.
Paramètres :
  • catalog - nom du catalogue du stockage cloud.
  • schema - nom du schéma du stockage cloud.
  • volume - nom du volume du stockage cloud dans le catalogue Unity.
  • objectPath – Chemin d’accès de l’objet (fichier) à partir du volume en tant que répertoire racine pour vérifier l’existence dans le volume (dans tous les sous-dossiers).
  • caseSensitive – Valeur booléenne indiquant si la vérification doit être sensible à la casse.

Retours :
Valeur booléenne 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 - nom du catalogue du stockage cloud.
  • schema - nom du schéma du stockage cloud.
  • volumeName – Nom du volume pour lequel l’existence doit être vérifiée.
  • caseSensitive Valeur booléenne indiquant si la vérification doit être sensible à la casse.

Retours :
Valeur booléenne 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 du volume catalogue Unity qui commencent par un préfixe spécifié. Le préfixe doit faire partie du chemin d’accès du fichier à partir du volume en tant que racine.
Paramètres :
  • catalog - nom du catalogue du stockage cloud.
  • schema - nom du schéma du stockage cloud.
  • volume - nom du volume UC du stockage cloud.
  • prefix - préfixe des noms de fichiers à répertorier. Cela inclut le chemin relatif du volume en tant que répertoire racine.
  • caseSensitive – Valeur booléenne indiquant si la vérification doit être sensible à la casse.

Retours :
Liste de chaînes indiquant les noms de fichiers qui commencent 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) à partir du volume catalogue Unity et le stocke dans le chemin local spécifié.
Paramètres :
  • catalog - nom du catalogue du stockage cloud.
  • schema - nom du schéma du stockage cloud.
  • volume - nom du volume UC du stockage cloud.
  • objectPath - le chemin de l'objet (fichier) à partir du volume comme répertoire racine.
  • localPath - chemin d’accès local où les données récupérées doivent être stockées.

Retours :
Valeur booléenne indiquant l’état de l’opération GET .
getObject (flux)
InputStreamEntity getObject(String catalog, String schema, String volume, String objectPath) throws SQLException
Récupère un objet en tant que flux d’entrée à partir du volume catalogue Unity.
Paramètres :
  • catalog - nom du catalogue du stockage cloud.
  • schema - nom du schéma du stockage cloud.
  • volume - nom du volume UC du stockage cloud.
  • objectPath - le chemin de l'objet (fichier) à partir du volume comme répertoire racine.

Retours :
Instance de l’entité de flux d’entrée.
putObject (fichier)
boolean putObject(String catalog, String schema, String volume, String objectPath, String localPath, boolean toOverwrite) throws SQLException
Charge les données d’un chemin local vers un chemin d’accès spécifié dans un volume de catalogue Unity.
Paramètres :
  • catalog - nom du catalogue du stockage cloud.
  • schema - nom du schéma du stockage cloud.
  • volume - nom du volume UC du stockage cloud.
  • objectPath Chemin d’accès à la destination où l’objet (fichier) doit être chargé à partir du `volume en tant que répertoire racine.
  • localPath chemin d’accès local à partir duquel les données doivent être chargées.
  • toOverwrite booléen indiquant s’il faut remplacer l’objet s’il existe déjà.

Retours :
Valeur booléenne indiquant l’état de l’opération PUT.
putObject (flux)
boolean putObject(String catalog, String schema, String volume, String objectPath, InputStream inputStream, long contentLength, boolean toOverwrite) throws SQLException
Charge les données d’un flux d’entrée vers un chemin d’accès spécifié dans un volume de catalogue Unity.
Paramètres :
  • catalog - nom du catalogue du stockage cloud.
  • schema - nom du schéma du stockage cloud.
  • volume - nom du volume UC du stockage cloud.
  • objectPath - chemin d’accès de destination où l’objet (fichier) doit être chargé à partir du volume en tant que répertoire racine.
  • inputStream - flux d’entrée à partir duquel les données doivent être chargées.
  • contentLength - longueur du flux d’entrée.
  • toOverwrite booléen indiquant s’il faut remplacer l’objet s’il existe déjà.

Retours :
Valeur booléenne indiquant l’état de l’opération PUT.
supprimerObjet
boolean deleteObject(String catalog, String schema, String volume, String objectPath) throws SQLException
Supprime un objet d’un chemin d’accès spécifié dans un volume de catalogue Unity.
Paramètres :
  • catalog - nom du catalogue du stockage cloud.
  • schema - nom du schéma du stockage cloud.
  • volume - nom du volume UC du stockage cloud.
  • objectPath – Chemin de l’objet (fichier) du volume en tant que répertoire racine à supprimer.

Retours :
Valeur booléenne indiquant l’état de l’opération DELETE.

Interface IDatabricksGeospatial

Décrit les méthodes permettant d’utiliser des types de données géospatiales (GEOMETRY et GEOGRAPHY). Cette interface est étendue par les interfaces marqueurs IGeometry et IGeography spécifiques aux types d'objets géospatiaux.

Colis: com.databricks.jdbc.api

getWKT
String getWKT()
Retourne la représentation Well-Known Text (WKT) de l’objet géospatial.
Retours :
Chaîne contenant la représentation WKT sans préfixe SRID.
getWKB
byte[] getWKB()
Retourne la représentation binaire connue (WKB) conforme à l’OGC de l’objet géospatial.
Retours :
Tableau d’octets contenant les données WKB.
getSRID
int getSRID()
Retourne l’identificateur de système de référence spatiale (SRID) de l’objet géospatial.
Retours :
Entier représentant la valeur SRID (0 s’il n’est pas spécifié).
getType
String getType()
Retourne le nom du type géospatial.
Retours :
Chaîne qui est soit GEOMETRY ou GEOGRAPHY.

Enum ExécutionState

Contient les états d’une requête asynchrone en cours d’exécution.

Colis: com.databricks.jdbc.api

RUNNING L’instruction s’exécute sur le serveur
PENDING L’instruction n’est pas encore exécutée sur le serveur
SUCCEEDED L’instruction s’est exécutée avec succès.
FAILED L’exécution de l’instruction a échoué.
ABORTED La déclaration a été abandonnée
CLOSED L’instruction a été fermée.

ExécutionState enum

Décrit les méthodes permettant de récupérer l’état d’une requête asynchrone.

Colis: com.databricks.jdbc.api

getExecutionState
ExecutionState getExecutionState() throws SQLException
Renvoie l’état de l’exécution.
Retours :
ExecutionState qui représente l’état de l’état d’exécution
getSqlState
String getSqlState() throws SQLException
S’il est défini, retourne le code SQLState pour un état ayant échoué.
Retours :
Une chaîne qui est le code SQLState
getErrorMessage
String getErrorMessage() throws SQLException
Retourne le message d’erreur d’une exécution ayant échoué.
Retours :
Une chaîne qui constitue le message d'erreur.
  • Last updated on