Paramètres de connexion avancés
Les sections suivantes décrivent les paramètres de connexion avancés pour le pilote JDBC 3.x.
Rubriques
Paramètres de chiffrement du résultat
Notez les points suivants :
-
La clé AWS KMS doit être spécifiée lorsque
EncryptionOptionestSSE_KMSouCSE_KMS. -
La clé AWS KMS ne peut pas être spécifiée lorsque
EncryptionOptionn'est pas spécifié ou lorsqueEncryptionOptionestSSE_S3.
Options de chiffrement
Le type de chiffrement à utiliser pour les résultats des requêtes lorsqu'ils sont stockés dans Amazon S3. Pour plus d'informations sur les options de chiffrement, veuillez consulter EncryptionConfiguration dans la Référence d'API Amazon Athena.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut | Valeurs possibles |
|---|---|---|---|---|
| EncryptionOption | S3OutputEncOption (obsolète) | Facultatif | Aucune | SSE_S3, SSE_KMS, CSE_KMS |
Clé KMS
L'ARN ou l'ID de la clé KMS, si SSE_KMS ou CSE_KMS est choisi comme option de chiffrement. Pour plus d'informations, veuillez consulter EncryptionConfiguration dans la Référence d'API Amazon Athena.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| KmsKey | S3OutputEncKMSKey (obsolète) | Facultatif | Aucune |
Paramètres de récupération des résultats
Récupérateur de résultats
Le récupérateur qui sera utilisé pour télécharger les résultats de la requête.
Le récupérateur de résultats par défaut, auto, télécharge les résultats des requêtes directement depuis Amazon S3 sans utiliser les API Athena. Lorsque le téléchargement direct depuis S3 n’est pas possible, par exemple lorsque les résultats des requêtes sont chiffrés avec l’option CSE_KMS, l’API GetQueryResultsStream est automatiquement utilisée.
En règle générale, il est recommandé d’utiliser le récupérateur auto. Si vos politiques IAM ou vos stratégies de compartiment S3 utilisent la condition s3:CalledVia pour limiter l’accès aux demandes d’objets S3 en provenance d’Athena, le récupérateur auto tente de télécharger les résultats depuis S3 avant d’utiliser l’API GetQueryResultsStream. Dans ce cas, vous pouvez définir ResultFetcher sur GetQueryResultsStream pour éviter un appel d’API supplémentaire.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut | Valeurs possibles |
|---|---|---|---|---|
| ResultFetcher | Aucune | Facultatif | auto | auto, S3, GetQueryResults, GetQueryResultsStream |
Taille d'extraction
La valeur de ce paramètre est utilisée comme valeur minimale pour les tampons internes et comme taille de page cible lors de la récupération des résultats. La valeur 0 (zéro) signifie que le pilote doit utiliser ses valeurs par défaut, comme décrit ci-dessous. La valeur maximale est 1 000 000.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| FetchSize | RowsToFetchPerBlock (obsolète) | Facultatif | 0 |
-
Le récupérateur
GetQueryResultsutilisera toujours une taille de page de 1 000, qui est la valeur maximale prise en charge par l'appel d'API. Lorsque la taille de récupération est supérieure à 1 000, plusieurs appels d'API successifs sont effectués pour remplir la mémoire tampon au-dessus du minimum. -
Le récupérateur
GetQueryResultsStreamutilisera la taille de lecture configurée comme taille de page, soit 10 000 par défaut. -
Le récupérateur
S3utilisera la taille de lecture configurée comme taille de page, soit 10 000 par défaut.
Paramètres de configuration des résultats
Propriétaire du compartiment attendu
ID de compte du propriétaire attendu du compartiment s3. Si l’ID de compte fourni ne correspond pas au propriétaire réel du compartiment, la demande échoue. Pour plus d’informations sur la vérification du propriétaire du compartiment s3, consultez Verifying bucket ownership.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| ExpectedBucketOwner | Aucune | Facultatif | Aucune |
Option Acl
Indique qu’une ACL prédéfinie Amazon S3 est nécessaire pour contrôler la propriété des résultats de requêtes stockés. Pour plus d’informations sur AclOption, consultez AclConfiguration.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut | Valeurs possibles |
|---|---|---|---|---|
| AclOption | Aucune | Facultatif | Aucune | BUCKET_OWNER_FULL_CONTROL |
Paramètres de réutilisation des résultats des requêtes
Activer la réutilisation des résultats
Indique si les résultats précédents de la même requête peuvent être réutilisés lors de l'exécution d'une requête. Pour plus d'informations sur la réutilisation des résultats des requêtes, veuillez consulter ResultReuseByAgeConfiguration.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| EnableResultReuseByAge | Aucune | Facultatif | FALSE |
Âge maximum de réutilisation des résultats
L'âge maximum, en minutes, d'un résultat de requête précédent qu'Athena doit envisager de réutiliser. Pour plus d'informations sur l'âge maximal de réutilisation des résultats, veuillez consulter ResultReuseByAgeConfiguration.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| MaxResultReuseAgeInMinutes | Aucune | Facultatif | 60 |
Paramètres d'interrogation pour l'exécution des requêtes
Intervalle d'interrogation minimal pour l'exécution des requêtes
La durée minimale, en millisecondes, à attendre avant d'interroger Athena sur l'état d'exécution de la requête.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| MinQueryExecutionPollingIntervalMillis | MinQueryExecutionPollingInterval (obsolète) | Facultatif | 100 |
Intervalle d'interrogation maximal pour l'exécution des requêtes
La durée maximale, en millisecondes, à attendre avant d'interroger Athena sur l'état d'exécution de la requête.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| MaxQueryExecutionPollingIntervalMillis | MaxQueryExecutionPollingInterval (obsolète) | Facultatif | 5000 |
Multiplicateur d'intervalle d'interrogation pour l'exécution des requêtes
Le facteur d'augmentation de la période d'interrogation. Par défaut, l'interrogation commence par la valeur de MinQueryExecutionPollingIntervalMillis et double à chaque interrogation jusqu'à atteindre la valeur de MaxQueryExecutionPollingIntervalMillis.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| QueryExecutionPollingIntervalMultiplier | Aucune | Facultatif | 2 |
Paramètres de remplacement du point de terminaison
Remplacement du point de terminaison Athena
Le point de terminaison que le pilote utilisera pour effectuer des appels d'API à Athena.
Notez les points suivants :
-
Si les protocoles
https://ouhttp://ne sont pas spécifiés dans l'URL fournie, le pilote insère le préfixehttps://. -
Si ce paramètre n'est pas spécifié, le pilote utilise un point de terminaison par défaut.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| AthenaEndpoint | EndpointOverride (obsolète) | Facultatif | Aucune |
Remplacement du point de terminaison du service de streaming Athena
Le point de terminaison que le pilote utilisera pour télécharger les résultats de la requête lorsqu'il utilisera le service de streaming Athena. Le service de streaming Athena est disponible sur le port 444.
Notez les points suivants :
-
Si les protocoles
https://ouhttp://ne sont pas spécifiés dans l'URL fournie, le pilote insère le préfixehttps://. -
Si aucun port n'est spécifié dans l'URL fournie, le pilote insère le port 444 du service de streaming.
-
Si le paramètre
AthenaStreamingEndpointn'est pas spécifié, le pilote utilise le remplacementAthenaEndpoint. Si ni le remplacementAthenaStreamingEndpointni le remplacementAthenaEndpointne sont spécifiés, le pilote utilise un point de terminaison de streaming par défaut.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| AthenaStreamingEndpoint | StreamingEndpointOverride (obsolète) | Facultatif | Aucune |
Remplacement du point de terminaison Lake Formation
Le point de terminaison que le pilote utilisera pour le service Lake Formation lorsqu'il utilisera l'API AWS Lake Formation AssumeDecoratedRoleWithSAML pour récupérer des informations d'identification temporaires. Si ce paramètre n'est pas spécifié, le pilote utilise un point de terminaison Lake Formation par défaut.
Notez les points suivants :
-
Si les protocoles
https://ouhttp://ne sont pas spécifiés dans l'URL fournie, le pilote insère le préfixehttps://.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| LakeFormationEndpoint |
LfEndpointOverride (obsolète) |
Facultatif | Aucune |
Remplacement du point de terminaison S3
Le point de terminaison que le pilote utilisera pour télécharger les résultats de la requête lorsqu'il utilise le récupérateur Amazon S3. Si ce paramètre n'est pas spécifié, le pilote utilise un point de terminaison Amazon S3 par défaut.
Notez les points suivants :
-
Si les protocoles
https://ouhttp://ne sont pas spécifiés dans l'URL fournie, le pilote insère le préfixehttps://.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| S3Endpoint | Aucune | Facultatif | Aucune |
Remplacement du point de terminaison STS
Le point de terminaison que le pilote utilisera pour le service AWS STS lorsqu'il utilisera l'API AWS STS AssumeRoleWithSAML pour récupérer des informations d'identification temporaires. Si ce paramètre n'est pas spécifié, le pilote utilise un point de terminaison AWS STS par défaut.
Notez les points suivants :
-
Si les protocoles
https://ouhttp://ne sont pas spécifiés dans l'URL fournie, le pilote insère le préfixehttps://.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| StsEndpoint | StsEndpointOverride (obsolète) | Facultatif | Aucune |
Remplacement du point de terminaison SSO OIDC
Point de terminaison que le pilote utilisera avec ClientConfiguration.endpointOverride pour remplacer le point de terminaison HTTP par défaut pour le client SSO OIDC. Pour plus d’informations, consultez ClientConfiguration.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| SSOOIDCEndpointOverride | Facultatif | Aucune |
Remplacement des points de terminaison d’administration SSO
Point de terminaison que le pilote utilisera avec ClientConfiguration.endpointOverride pour remplacer le point de terminaison HTTP par défaut pour le client d’administration SSO. Pour plus d’informations, consultez ClientConfiguration.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| SSOAdminEndpointOverride | Facultatif | Aucune |
Paramètres de configuration du proxy
Hôte proxy
L'URL de l'hôte proxy. Utilisez ce paramètre si vous souhaitez que les requêtes Athena passent par un proxy.
Note
Assurez-vous d'inclure le protocole https:// ou http:// au début de l'URL de ProxyHost.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| ProxyHost | Aucune | Facultatif | Aucune |
Port proxy
Le port à utiliser sur l'hôte proxy. Utilisez ce paramètre si vous souhaitez que les requêtes Athena passent par un proxy.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| ProxyPort | Aucune | Facultatif | Aucune |
Nom d'utilisateur du proxy
Le nom d'utilisateur permettant de s'authentifier sur le serveur proxy. Utilisez ce paramètre si vous souhaitez que les requêtes Athena passent par un proxy.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| ProxyUsername | ProxyUID (obsolète) | Facultatif | Aucune |
Mot de passe proxy
Le mot de passe permettant de s'authentifier sur le serveur proxy. Utilisez ce paramètre si vous souhaitez que les requêtes Athena passent par un proxy.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| ProxyPassword | ProxyPWD (obsolète) | Facultatif | Aucune |
Les hôtes exempts de proxy
Un ensemble de noms d'hôtes auxquels le pilote se connecte sans utiliser de proxy lorsque le proxy est activé (c'est-à-dire lorsque les paramètres de connexion ProxyHost et ProxyPort sont définis). Les hôtes doivent être séparés par le caractère de barre verticale (|) (par exemple host1.com|host2.com).
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| ProxyExemptHosts | NonProxyHosts | Facultatif | Aucune |
Proxy activé pour les fournisseurs d'identité
Spécifie si un proxy doit être utilisé lorsque le pilote se connecte à un fournisseur d'identité.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| ProxyEnabledForIdP | UseProxyForIdP | Facultatif | FALSE |
Paramètres de journalisation
Cette section décrit les paramètres liés à la journalisation.
Niveau de journalisation
Spécifie le niveau de journalisation du pilote. Rien n'est journalisé, sauf si le paramètre LogPath est également défini.
Note
Nous vous recommandons de ne définir que le paramètre LogPath, sauf si vous avez des exigences particulières. La définition du seul paramètre LogPath permet d'activer la journalisation et d'utiliser le niveau de journalisation TRACE par défaut. Le niveau de journalisation TRACE fournit la journalisation la plus détaillée.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut | Valeurs possibles |
|---|---|---|---|---|
| LogLevel | Aucune | Facultatif | TRACE | OFF, ERROR, WARN, INFO, DEBUG, TRACE |
Chemin d'accès au journal
Le chemin d'accès à un répertoire de l'ordinateur qui exécute le pilote dans lequel les journaux du pilote seront stockés. Un fichier journal avec un nom unique sera créé dans le répertoire spécifié. Si cette option est définie, la journalisation du pilote est activée.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| LogPath | Aucune | Facultatif | Aucune |
Nom de l'application
Le nom de l'application qui utilise le pilote. Si une valeur est spécifiée pour ce paramètre, elle est incluse dans la chaîne d'agent utilisateur des appels d'API que le pilote effectue à Athena.
Note
Vous pouvez également définir le nom de l'application en appelant setApplicationName sur l'objet DataSource.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| ApplicationName | Aucune | Facultatif | Aucune |
Test de connexion
S'il est défini sur TRUE, le pilote effectue un test de connexion chaque fois qu'une connexion JDBC est créée, même si aucune requête n'est exécutée sur la connexion.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| ConnectionTest | Aucune | Facultatif | TRUE |
Note
Un test de connexion envoie une requête SELECT 1 à Athena pour vérifier que la connexion a été correctement configurée. Cela signifie que deux fichiers seront stockés dans Amazon S3 (le jeu de résultats et les métadonnées), et des frais supplémentaires peuvent s'appliquer conformément à la tarification d'Amazon Athena
Nombre de nouvelles tentatives
Le nombre maximal de fois que le pilote doit renvoyer une requête réitérable à Athena.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
| NumRetries | MaxErrorRetry (obsolète) | Facultatif | Aucune |
Délai d'expiration du réseau
Le délai d’expiration du réseau détermine combien de temps le pilote attend l’établissement d’une connexion réseau. Il inclut le temps d’envoi de demandes d’API. Dans de rares cas, il peut être utile de modifier le délai d’expiration du réseau. Par exemple, vous souhaiterez peut-être l’augmenter pour les longues pauses du récupérateur de mémoire. La définition de ce paramètre de connexion revient à utiliser la méthode setNetworkTimeout sur un objet Connection.
| Nom du paramètre | Alias | Type de paramètre | Valeur par défaut |
|---|---|---|---|
|
NetworkTimeoutMillis |
Aucune | Facultatif | Aucune |