Voici un tableau de référence des différents API de CouchDB :
| Nom | Description |
|---|---|
| / | Cette API permet de retourner des méta-informations sur l'instance. |
| /_active_tasks | Cette API permet de demander la liste des tâches en cours d'exécution, y compris le type de tâche, le nom, l'état et l'identificateur de processus. |
| /_all_dbs | Cette API permet de demander la liste de toutes les bases de données de l'instance CouchDB. |
| /_cluster_setup | Cette API permet de demander l'état du noeud ou de l'unité d'allocation, selon l'assistant de configuration de l'unité d'allocation. |
| /_db_updates | Cette API permet de demander une liste de tous les événements de base de données dans l'instance CouchDB. |
| /_dbs_info | Cette API permet de demander les informations d'une liste des bases de données spécifiées dans l'instance CouchDB. |
| /_membership | Cette API permet d'afficher les noeuds faisant partie de l'unité d'allocation en tant que cluster_nodes. |
| /_node/{node-name} | Cette API permet de confirmer le nom de noeud Erlang du serveur traitant la demande. |
| /_node/{node-name}/_restart | Cette API permet de redémarrer la base de données. Cette API est destinée à faciliter les tests d'intégration uniquement, elle n'est pas destinée à être utilisée en production. |
| /_node/{node-name}/_stats | Cette API permet de demander un objet JSON contenant les statistiques du serveur en cours d'exécution. |
| /_node/{node-name}/_system | Cette API permet de demander un objet JSON contenant diverses statistiques au niveau du système pour le serveur en cours d'exécution. |
| /_replicate | Cette API permet de demander, configurer ou arrêter une opération de réplication. |
| /_reshard | Cette API permet de demander un nombre de travaux terminés, échoués, en cours d'exécution, arrêtés et totaux, ainsi que l'état de redistribution sur l'unité d'allocation. |
| /_reshard/jobs | Cette API permet de demander la forme de la réponse. |
| /_reshard/state | Cette API permet de demander l'état de partage et des informations facultatives sur l'état. |
| /_scheduler/docs | Cette API permet de demander l'état des réplications basées sur des documents. |
| /_scheduler/docs/{replicator_db} | Cette API permet de demander des informations sur les documents de réplication à partir d'une base de données de réplicateur. |
| /_scheduler/docs/{replicator_db}/{docid} | Cette API permet de demander les noms de base de données du réplicateur n'ayant pas à être échappées. |
| /_scheduler/jobs | Cette API permet de demander la liste des tâches de réplication. |
| /_search_analyze | Cette API permet de tester les résultats de jeton de l'analyseur Lucene sur un exemple de texte. |
| /_up | Cette API permet de confirmer que le serveur est opérationnel, en cours d'exécution et prêt à répondre aux demandes. |
| /_utils | Cette API permet d'accéder à l'interface d'administration intégrée de Fauxton pour CouchDB. |
| /_uuids | Cette API permet de demander un ou plusieurs identificateurs universellement uniques (UUID) à l'instance CouchDB. |
| /{db} | Cette API permet de créer une nouvelle base de données. |
| /{db}/_all_docs | Cette API permet d'exécuter la vue _all_docs intégrée, renvoyant tous les documents de la base de données. |
| /{db}/_all_docs | Cette API permet de prendre en charge des paramètres et un comportement identiques à ceux spécifiés dans l'API GET /{db}/_all_docs, mais permet aux paramètres de chaîne de caractères de requête d'être fournis sous forme de clefs dans un objet JSON dans le corps de la requête POST. |
| /{db}/_bulk_docs | Cette API permet de créer et de mettre à jour plusieurs documents en même temps dans une seule demande. |
| /{db}/_bulk_get | Cette API permet d'interroger plusieurs documents en masse. |
| /{db}/_design_docs | Cette API permet de retourner une structure JSON de tous les documents de conception dans une base de données spécifiée. |
| /db | Cette API permet de demander les entêtes HTTP contenant une quantité minimale d'informations sur la base de données spécifiée. |
| /db/_changes | Cette API permet de demander une liste triée des modifications apportées aux documents de la base de données, par ordre chronologique de l'application, peut être obtenue à partir de la ressource _changes de la base de données. |
| /db/_compact | Cette API permet de demander le compactage de la base de données spécifiée. |
| /db/_compact/design-doc | Cette API permet de compacter les index de vue associés au document de conception spécifié. |
| /db/_design/design-doc | Cette API permet de demander les entêtes HTTP contenant une quantité minimale d'informations sur le document de conception spécifié. |
| /db/_design/design-doc/_info | Cette API permet de demander des informations sur le document de conception spécifié, y compris l'index, la taille d'index et l'état actuel du document de conception et les informations d'index associées. |
| /db/_design/design-doc/_list/list-name/other-ddoc/view-name | Cette API permet d'appliquer la fonction de liste à la fonction d'affichage de l'autre document de conception. |
| /db/_design/design-doc/_list/list-name/view-name | Cette API permet d'appliquer la fonction de liste pour la fonction d'affichage à partir du même document de conception. |
| /db/_design/design-doc/_rewrite/path | Cette API permet de réécrire le chemin spécifié selon les règles définies dans le document de conception spécifié. |
| /db/_design/design-doc/_search/index-name | Cette API permet d'exécuter une demande de recherche par rapport à l'index nommé dans le document de conception spécifié. |
| /db/_design/design-doc/_search_info/index-name | Cette API permet d'exécuter une demande de recherche d'informations par rapport à l'index. |
| /db/_design/design-doc/_show/show-name | Cette API permet de demander le nom du document. |
| /db/_design/design-doc/_show/show-name/doc-id | Cette API permet de demander le nom du document par son identificateur. |
| /db/_design/design-doc/_update/update-name | Cette API permet d'exécuter la fonction de mise à jour côté serveur pour un document nul. |
| /db/_design/design-doc/_update/update-name/doc-id | Cette API permet d'exécuter la fonction de mise à jour côté serveur pour le document spécifié. |
| /db/_design/design-doc/_view/view-name | Cette API permet d'exécuter la fonction d'affichage spécifiée à partir du document de conception spécifié. |
| /db/_design/design-doc/attachment | Cette API permet de demander les entêtes HTTP contenant une quantité minimale d'informations sur la pièce jointe spécifiée. |
| /db/_ensure_full_commit | Cette API permet de valider les modifications récentes de la base de données au cas où l'option delay_commits=true serait définie. |
| /db/_explain | Cette API permet d'indiquer quel index est utilisé par la requête. |
| /db/_find | Cette API permet de rechercher des documents à l'aide d'une syntaxe d'interrogation JSON déclarative. |
| /db/_index | Cette API permet de demander un index Mango. |
| /db/_local/id | Cette API permet de demander le document local spécifié. |
| /db/_local_docs | Cette API permet de demander une structure JSON de tous les documents locaux dans une base de données spécifié. |
| /db/_missing_revs | Cette API permet d'effectuer une liste de révisions de document spécifiée et de retourner les révisions de document n'existant pas dans la base de données. |
| /db/_partition/partition | Cette API permet de retourner des informations décrivant la partition fournie. |
| /db/_partition/partition/_all_docs | Cette API permet de définir automatiquement des limites sur l'intervalle de partition fournie. |
| /db/_partition/partition/_design/design-doc/_view/view-name | Cette API permet d'exécuter une requête partitionnée. |
| /db/_partition/partition_id/_explain | Cette API permet de montrer quel index est utilisé par la requête. |
| /db/_partition/partition_id/_find | Cette API permet de rechercher une requête de partition par son identificateur. |
| /db/_purge | Cette API permet une purge de base de données, soit la suppression définitive des références aux documents dans la base de données. |
| /db/_purged_infos_limit | Cette API permet de demander le paramètre actuel purged_infos_limit (limite de documents purgés), le nombre maximal de purges historiques (identificateur de document purgés avec leurs révisions) pouvant être entreposées dans la base de données. |
| /db/_revs_diff | Cette API permet de retourner le sous-ensemble de ceux ne correspondant pas aux révisions entreposées dans la base de données. |
| /db/_revs_limit | Cette API permet de demander le paramètre actuel revs_limit (limite de révision). |
| /db/_security | Cette API permet de demander l'objet de sécurité actuel de la base de données spécifiée. |
| /db/_shards | Cette API permet de demander une liste de fragments de base de données. |
| /db/_shards/doc | Cette API permet de demander des informations sur la partition spécifique dans laquelle un document donné a été entreposé, ainsi que des informations sur les noeuds sur lesquels cette partition a une réplique. |
| /db/_sync_shards | Cette API permet de forcer ou démarrer la synchronisation interne des fragments pour tous les réplicas de tous les fragments de base de données. |
| /db/_view_cleanup | Cette API permet de supprimer les fichiers d'index de vue n'étant plus requis par CouchDB en raison de la modification des vues dans les documents de conception. |
| /db/doc | Cette API permet de demander les entêtes HTTP contenant une quantité minimale d'informations sur le document spécifié. |
| /db/doc/attachment | Cette API permet de demander les informations d'attachement. |
| /favicon.ico | Cette API permet de demander le contenu binaire pour l'icône du site favicon.ico. |
Dernière mise à jour : Vendredi, le 9 septembre 2020