PostgreSQL

Le type de connecteur PostgreSQL vous permet d'insérer, de lire, de mettre à jour et de supprimer des lignes dans une base de données PostgreSQL.

Versions compatibles

PostgreSQL 7.4 et versions ultérieures

Avant de commencer

Avant d'utiliser le connecteur PostgreSQL, effectuez les tâches suivantes :

Dans votre projet Google Cloud :
- Assurez-vous que la connectivité réseau est configurée. Pour en savoir plus sur les schémas de réseau, consultez Connectivité réseau.
- Attribuez le rôle IAM roles/connectors.admin à l'utilisateur qui configure le connecteur.
- Attribuez les rôles IAM suivants au compte de service que vous souhaitez utiliser pour le connecteur :
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  Un compte de service est un type spécial de compte Google destiné à représenter un utilisateur non humain qui doit s'authentifier et obtenir les autorisations permettant d'accéder aux données des API Google. Si vous ne possédez pas de compte de service, vous devez en créer un. Pour plus d'informations, consultez Créer un compte de service.
- Activez les services suivants :
  - secretmanager.googleapis.com (API Secret Manager)
  - connectors.googleapis.com (API Connectors)
  Pour savoir comment activer des services, consultez Activer des services.
Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer au moment de configurer le connecteur.

Configurer le connecteur

Une connexion est propre à une source de données. Cela signifie que si vous disposez de nombreuses sources de données, vous devez créer une connexion distincte pour chacune d'elles. Pour créer une connexion, procédez comme suit :

Dans la console Cloud, accédez à la page Connecteurs d'intégration > Connexions, puis sélectionnez ou créez un projet Google Cloud.
Accéder à la page "Connexions"
Cliquez sur + Créer pour ouvrir la page Créer une connexion.
Dans la section Emplacement, choisissez l'emplacement de la connexion.
1. Région : sélectionnez un emplacement dans la liste déroulante.
  Pour obtenir la liste de toutes les régions disponibles, consultez Emplacements.
2. Cliquez sur Suivant.
Dans la section Détails de connexion, procédez comme suit :
1. Connecteur : sélectionnez PostgreSQL dans la liste déroulante des connecteurs disponibles.
2. Version du connecteur : sélectionnez la version du connecteur dans la liste déroulante des versions disponibles.
3. Dans le champ Nom de connexion, indiquez le nom de l'instance de connexion.
  Les noms de connexion doivent répondre aux critères suivants :
  - Ils peuvent contenir des lettres, des chiffres ou des traits d'union.
  - Les lettres doivent être en minuscules.
  - Ils doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
  - Ils ne peuvent pas dépasser 49 caractères.
4. (Facultatif) Saisissez une description de l'instance de connexion.
5. (Facultatif) Activez Cloud Logging, puis sélectionnez un niveau de journalisation. Par défaut, le niveau de journalisation est défini sur Error.
6. Compte de service : sélectionnez un compte de service disposant des rôles requis.
7. (Facultatif) Configurez les paramètres de nœuds de connexion :
  - Nombre minimal de nœuds : saisissez le nombre minimal de nœuds de connexion.
  - Nombre maximal de nœuds : saisissez le nombre maximal de nœuds de connexion.
  Un nœud est une unité (ou instance répliquée) de connexion qui traite des transactions. Pour traiter davantage de transactions pour une connexion, vous devez disposer de plus de nœuds. À l'inverse, moins de nœuds sont nécessaires si une connexion traite moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez Tarifs des nœuds de connexion. Si vous ne saisissez aucune valeur, le nombre minimal de nœuds est défini par défaut sur 2 (pour améliorer la disponibilité) et le nombre maximal de nœuds sur 50.
8. Nom de la base de données : nom de la base de données PostgreSQL à laquelle vous souhaitez vous connecter.
9. Utiliser un proxy : cochez cette case afin de configurer un serveur proxy pour la connexion ainsi que les valeurs suivantes :
10. (Facultatif) Cliquez sur + Ajouter une étiquette pour ajouter une étiquette à la connexion sous la forme d'une paire clé/valeur.
11. Si vous souhaitez utiliser SSL, sélectionnez Activer SSL. Les détails de la configuration SSL s'affichent.
  1. Sélectionnez un type de truststore. Vous avez le choix entre Public, Privé ou Connexion non sécurisée.
  2. Sélectionnez les certificats tels qu'ils sont affichés en fonction du truststore que vous avez choisi.
  3. Si vous utilisez mTLS, sélectionnez les certificats du keystore dans la section Keystore.
  Remarque :
  - Tous vos certificats doivent être des certificats X.509 au format PEM (Privacy Enhanced Mail).
  - Vous ne pouvez pas sélectionner directement un certificat lorsque vous configurez SSL. Vous devez stocker tous vos certificats et clés privées en tant que secrets Secret Manager, puis sélectionner le secret requis lors de la configuration SSL.
12. Cliquez sur Suivant.
Dans la section Destinations, saisissez des informations sur l'hôte distant (système backend) auquel vous souhaitez vous connecter.
1. Type de destination : sélectionnez un type de destination.
  - Sélectionnez Adresse de l'hôte dans la liste pour spécifier le nom d'hôte ou l'adresse IP de la destination.
  - Si vous souhaitez établir une connexion privée à vos systèmes backend, sélectionnez Rattachement de point de terminaison dans la liste, puis sélectionnez le rattachement de point de terminaison requis dans la liste Rattachement de point de terminaison.
    Remarque : Pour savoir comment créer un rattachement de point de terminaison, consultez Rattachement de service PSC et Rattachement de point de terminaison. Une fois le rattachement de point de terminaison créé, il apparaît dans la liste Rattachement de point de terminaison.
  Si vous souhaitez établir une connexion publique à vos systèmes backend avec une sécurité supplémentaire, vous pouvez envisager de configurer des adresses IP sortantes statiques pour vos connexions, puis de configurer vos règles de pare-feu pour ajouter à la liste d'autorisation uniquement les adresses IP statiques spécifiques.
  
  Pour saisir d'autres destinations, cliquez sur + Ajouter une destination.
2. Cliquez sur Suivant.
Dans la section Authentification, saisissez les informations d'authentification.
1. Sélectionnez un type d'authentification, puis saisissez les informations appropriées.
  Les types d'authentification suivants sont compatibles avec la connexion PostgreSQL :
  - Nom d'utilisateur et mot de passe
2. Cliquez sur Suivant.
Vérifier : vérifiez vos informations de connexion et d'authentification.
Cliquez sur Créer.

Configurer l'authentification

Saisissez les informations en fonction de l'authentification que vous souhaitez utiliser.

Nom d'utilisateur et mot de passe
- Nom d'utilisateur : nom d'utilisateur PostgreSQL à utiliser pour la connexion
- Mot de passe : secret Secret Manager contenant le mot de passe associé au nom d'utilisateur PostgreSQL

Entités, opérations et actions

Tous les connecteurs Integration Connectors fournissent une couche d'abstraction pour les objets de l'application connectée. Vous ne pouvez accéder aux objets d'une application que par le biais de cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.

Entité : une entité peut être considérée comme un objet ou un ensemble de propriétés dans l'application ou le service connectés. La définition d'une entité diffère d'un connecteur à l'autre. Par exemple, dans un connecteur de base de données, les tables sont les entités, alors que dans un connecteur de serveur de fichiers, ce sont les dossiers, et dans un connecteur de système de messagerie, ce sont les files d'attente.
Toutefois, il est possible qu'un connecteur n'accepte ou ne possède aucune entité. Dans ce cas, la liste Entities est vide.
Opération : une opération est l'activité que vous pouvez effectuer sur une entité. Voici les opérations possibles :
- List
- Get
- Create
- Update
- Delete
Lorsque vous sélectionnez une entité dans la liste proposée, cela génère une liste d'opérations disponibles pour l'entité. Pour obtenir une description détaillée des opérations, consultez les opérations d'entité de la tâche "Connecteurs". Cependant, si un connecteur n'accepte pas l'une des opérations d'entité, cette opération non compatible ne figure pas dans la liste Operations.
Action : une action est une fonction de première classe mise à la disposition de l'intégration par le biais de l'interface du connecteur. Une action vous permet de modifier une ou plusieurs entités, et varie d'un connecteur à l'autre. Normalement, une action comporte des paramètres d'entrée et un paramètre de sortie. Toutefois, il est possible qu'un connecteur n'accepte aucune action, auquel cas la liste Actions est vide.

Limites du système

Le connecteur PostgreSQL peut traiter neuf transactions par seconde et par nœud, et limite les transactions qui dépassent cette limite. Par défaut, Integration Connectors alloue deux nœuds (pour améliorer la disponibilité) à une connexion.

Pour en savoir plus sur les limites applicables à Integration Connectors, consultez Limites.

Remarque : L'autoscaling du nombre de nœuds Integration Connectors s'effectue de manière dynamique en fonction de votre utilisation. Toutefois, si vous souhaitez réserver de la capacité pour de gros volumes sans attendre l'autoscaling, vous pouvez ajuster le nombre minimal de nœuds pour une connexion. Pour traiter davantage de transactions pour une connexion, vous devez disposer de plus de nœuds. À l'inverse, moins de nœuds sont nécessaires si une connexion traite moins de transactions. Pour configurer les valeurs de nœuds, procédez comme suit :

Si vous avez opté pour le paiement à l'usage, configurez le nombre minimal et le nombre maximal de nœuds sur la page "Modifier la connexion".
Si vous avez souscrit un abonnement, contactez l'assistance.

Le nombre maximal de transactions qu'un nœud peut traiter dépend de plusieurs facteurs. Par conséquent, avant que vous ajustiez le nombre minimal de nœuds pour améliorer le débit, nous vous recommandons de vérifier si vos systèmes backend sont configurés de manière optimale pour gérer le trafic requis.

Types de données acceptés

Voici les types de données acceptés pour ce connecteur :

BIGINT
BINARY
BIT
BOOLEAN
CHAR
DATE
DECIMAL
DOUBLE
FLOAT
INTEGER
LONGN VARCHAR
LONG VARCHAR
NCHAR
NUMERIC
NVARCHAR
REAL
SMALL INT
TIME
TIMESTAMP
TINY INT
VARBINARY
VARCHAR

Utiliser Terraform pour créer des connexions

Vous pouvez utiliser la ressource Terraform pour créer une connexion.

Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez Commandes Terraform de base.

Pour afficher un exemple de modèle Terraform permettant de créer une connexion, consultez Exemple de modèle.

Lorsque vous créez cette connexion à l'aide de Terraform, vous devez définir les variables suivantes dans votre fichier de configuration Terraform :

Nom du paramètre	Type de données	Obligatoire	Description
database_name	STRING	True	Nom de la base de données PostgreSQL à laquelle vous devez vous connecter.
proxy_enabled	BOOLEAN	False	Cochez cette case afin de configurer un serveur proxy pour la connexion.
proxy_auth_scheme	ENUM	False	Type d'authentification à utiliser pour s'authentifier auprès du proxy ProxyServer. Valeurs acceptées : BASIC, DIGEST et NONE.
proxy_user	STRING	False	Nom d'utilisateur permettant de s'authentifier auprès du proxy ProxyServer.
proxy_password	SECRET	False	Mot de passe à utiliser pour s'authentifier auprès du proxy ProxyServer.
proxy_ssltype	ENUM	False	Type SSL à utiliser pour se connecter au proxy ProxyServer. Valeurs acceptées : AUTO, ALWAYS, NEVER et TUNNEL.

Actions

Ce connecteur est compatible avec l'exécution des actions suivantes :

Fonctions et procédures stockées définies par l'utilisateur. Si votre backend contient des fonctions et des procédures stockées, elles sont listées dans la colonne Actions de la boîte de dialogue Configure connector task.
Requêtes SQL personnalisées. Pour exécuter des requêtes SQL personnalisées, le connecteur fournit l'action Exécuter une requête personnalisée.

Pour créer une requête personnalisée, procédez comme suit :
1. Suivez les instructions détaillées pour ajouter une tâche "Connecteurs".
2. Lorsque vous configurez la tâche "Connecteurs", sélectionnez Actions dans le type d'action à effectuer.
3. Dans la liste Action, sélectionnez Exécuter une requête personnalisée, puis cliquez sur OK.
4. Développez la section Entrée de la tâche, puis procédez comme suit :
  1. Dans le champ Délai d'inactivité après, saisissez le nombre de secondes d'attente jusqu'à l'exécution de la requête.
    Valeur par défaut : 180 secondes
  2. Dans le champ Nombre maximal de lignes, saisissez le nombre maximal de lignes à renvoyer à partir de la base de données.
    Valeur par défaut : 25
  3. Pour mettre à jour la requête personnalisée, cliquez sur Modifier le script personnalisé. La boîte de dialogue Éditeur de script s'ouvre.
  4. Dans la boîte de dialogue Éditeur de script, saisissez la requête SQL, puis cliquez sur Enregistrer.
    Vous pouvez utiliser un point d'interrogation (?) dans une instruction SQL pour représenter un seul paramètre devant être spécifié dans la liste des paramètres de requête. Par exemple, la requête SQL suivante sélectionne toutes les lignes de la table Employees correspondant aux valeurs spécifiées pour la colonne LastName :
```
SELECT * FROM Employees where LastName=?
```
    Remarque : Les instructions LMD (langage de manipulation de données) et LDD (langage de définition de données) sont acceptées.
  5. Si vous avez utilisé des points d'interrogation dans votre requête SQL, vous devez ajouter le paramètre en cliquant sur + Ajouter un nom de paramètre pour chaque point d'interrogation. Lors de l'exécution de l'intégration, ces paramètres remplacent les points d'interrogation (?) de la requête SQL de manière séquentielle. Par exemple, si vous avez ajouté trois points d'interrogation (?), vous devez ajouter trois paramètres dans l'ordre de séquence.
    
    Pour ajouter des paramètres de requête, procédez comme suit :
    1. Dans la liste Type, sélectionnez le type de données du paramètre.
    2. Dans le champ Valeur, saisissez la valeur du paramètre.
    3. Pour ajouter plusieurs paramètres, cliquez sur + Ajouter un paramètre de requête.
    Pour une requête complexe, utilisez "$1" au lieu de "?" dans votre requête. Voici un exemple de requête utilisant "$1" :
```
SELECT
od.order_number,
od.total_amount,
COALESCE(json_agg( json_build_object( 'item_name',
      oid.item_name, 'item_quantity', oid.item_quantity,
      'item_price', oid.item_price ) ) FILTER (
WHERE
  oid.order_number IS NOT NULL), '[]') AS order_items,
  COALESCE(json_agg( json_build_object( 'discount_type',
  odd.discount_type, 'discount_value', odd.discount_value ) ) FILTER (
WHERE
    oid.order_number IS NOT NULL), '[]') AS order_discounts
FROM
  order_details od
LEFT JOIN
  order_items_details oid
ON
  od.order_number = oid.order_number
LEFT JOIN
  order_discount_details odd
ON
  od.order_number = odd.order_number
WHERE
  od.order_number = $1
```

Exemples d'actions

Exemple : Trouver la valeur la plus élevée

Cet exemple montre comment exécuter une fonction définie par l'utilisateur. Dans cet exemple, la fonction find_greater compare deux entiers et renvoie l'entier le plus élevé.

Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
Sélectionnez l'action find_greater, puis cliquez sur OK.
Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
```
{
"$1": 1.0,
"$2": 5.0
}
```

Si l'action aboutit, le champ connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

[{
"bignum": 5.0
}]

Exemples d'opérations d'entité

Exemple : Lister les enregistrements d'une entité

Cet exemple liste les enregistrements de l'entité Users.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez Users dans la liste Entity.
Sélectionnez l'opération List, puis cliquez sur OK.
Dans la section Entrée de la tâche de la tâche Connecteurs, vous pouvez définir la filterClause selon vos besoins.

Par exemple, si vous définissez la clause de filtre sur employeeCode='5100' and startDate='2010-01-01 00:00:00', vous ne voyez que les enregistrements dont l'employeeCode est 5100 et la startDate est 2010-01-01 00:00:00.

Exemple : Récupérer un seul enregistrement à partir d'une entité

Cet exemple récupère un enregistrement de l'entité Users.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez User dans la liste Entity.
Sélectionnez l'opération Get, puis cliquez sur OK.
Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez 103032 dans le champ Valeur par défaut.
Ici, 103032 est la valeur de la clé primaire de l'entité Users.

Exemple : Supprimer un enregistrement d'une entité

Cet exemple supprime un enregistrement de l'entité Users.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez Users dans la liste Entity.
Sélectionnez l'opération Delete, puis cliquez sur OK.
Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez 113132 dans le champ Valeur par défaut.
Si l'entité comporte des clés primaires composites, vous pouvez définir la filterClause au lieu de spécifier l'entityId. Par exemple, employeeCode='5100' and startDate='2010-01-01 00:00:00'.

Exemple : Créer un enregistrement dans une entité

Cet exemple crée un enregistrement dans l'entité Users.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez Users dans la liste Entity.
Sélectionnez l'opération Create, puis cliquez sur OK.
Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
```
{
"employeeCode": "5100",
"startDate": "2010-01-01 00:00:00.0",
"country": "US"
}
```

Si l'intégration aboutit, le champ connectorOutputPayload de la tâche "Connecteurs" contiendra la réponse de l'opération de création.

Exemple : Mettre à jour un enregistrement dans une entité

Cet exemple met à jour un enregistrement dans l'entité Users.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez Users dans la liste Entity.
Sélectionnez l'opération Update, puis cliquez sur OK.
Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
```
{
"country": "IN"
}
```
Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez 113132 dans le champ Valeur par défaut.
Si l'entité comporte des clés primaires composites, vous pouvez définir la filterClause au lieu de spécifier l'entityId. Par exemple, employeeCode='5100' and startDate='2010-01-01 00:00:00'.

Si l'intégration aboutit, le champ connectorOutputPayload de la tâche "Connecteurs" contiendra la réponse de l'opération de mise à jour.

Utiliser la connexion PostgreSQL dans une intégration

Une fois la connexion créée, elle devient disponible dans Apigee Integration et Application Integration. Vous pouvez utiliser la connexion dans une intégration au moyen de la tâche "Connecteurs".

Pour savoir comment créer et utiliser la tâche "Connecteurs" dans Apigee Integration, consultez Tâche "Connecteurs".
Pour savoir comment créer et utiliser la tâche "Connecteurs" dans Application Integration, consultez Tâche "Connecteurs".

Demander de l'aide à la communauté Google Cloud

Vous pouvez publier vos questions et discuter de ce connecteur sur les forums Cloud de la communauté Google Cloud.

Étapes suivantes

Découvrez comment suspendre et reprendre une connexion.
Découvrez comment surveiller l'utilisation des connecteurs.
Découvrez comment afficher les journaux des connecteurs.