Spec-Zone.ru › CouchDB 3.5

Справочник API

Компоненты пути URL API помогают определить, к какой части сервера CouchDB выполняется обращение. В результате структура запроса URL одновременно указывает на область базы данных, к которой вы обращаетесь, и фактически описывает её.

Как и во всех URL, отдельные компоненты разделяются косой чертой.

Как правило, компоненты URL и поля JSON, начинающиеся с символа _ (подчёркивание), обозначают специальный компонент или сущность на сервере либо в возвращаемом объекте. Например, фрагмент URL /_all_dbs возвращает список всех баз данных экземпляра CouchDB.

Этот справочник организован в соответствии со структурой URL, как показано ниже.

  • 1.1. Основы API
    • 1.1.1. Формат запросов и ответы
    • 1.1.2. Заголовки HTTP
    • 1.1.3. Основы JSON
    • 1.1.4. Коды состояния HTTP
  • 1.2. Сервер
    • 1.2.1. /
    • 1.2.2. /_active_tasks
    • 1.2.3. /_all_dbs
    • 1.2.4. /_dbs_info
    • 1.2.5. /_cluster_setup
    • 1.2.6. /_db_updates
    • 1.2.7. /_membership
    • 1.2.8. /_replicate
    • 1.2.9. /_scheduler/jobs
    • 1.2.10. /_scheduler/docs
    • 1.2.11. /_node/{node-name}
    • 1.2.12. /_node/{node-name}/_stats
    • 1.2.13. /_node/{node-name}/_prometheus
    • 1.2.14. /_node/{node-name}/_smoosh/status
    • 1.2.15. /_node/{node-name}/_system
    • 1.2.16. /_node/{node-name}/_restart
    • 1.2.17. /_node/{node-name}/_versions
    • 1.2.18. /_search_analyze
    • 1.2.19. /_nouveau_analyze
    • 1.2.20. /_utils
    • 1.2.21. /_up
    • 1.2.22. /_uuids
    • 1.2.23. /favicon.ico
    • 1.2.24. /_reshard
    • 1.2.25. Аутентификация
    • 1.2.26. Конфигурация
  • 1.3. Базы данных
    • 1.3.1. /{db}
    • 1.3.2. /{db}/_all_docs
    • 1.3.3. /{db}/_design_docs
    • 1.3.4. /{db}/_bulk_get
    • 1.3.5. /{db}/_bulk_docs
    • 1.3.6. /{db}/_find
    • 1.3.7. /{db}/_index
    • 1.3.8. /{db}/_explain
    • 1.3.9. /{db}/_shards
    • 1.3.10. /{db}/_shards/{docid}
    • 1.3.11. /{db}/_sync_shards
    • 1.3.12. /{db}/_changes
    • 1.3.13. /{db}/_compact
    • 1.3.14. /{db}/_compact/{ddoc}
    • 1.3.15. /{db}/_ensure_full_commit
    • 1.3.16. /{db}/_view_cleanup
    • 1.3.17. /{db}/_search_cleanup
    • 1.3.18. /{db}/_nouveau_cleanup
    • 1.3.19. /{db}/_security
    • 1.3.20. /{db}/_purge
    • 1.3.21. /{db}/_purged_infos
    • 1.3.22. /{db}/_purged_infos_limit
    • 1.3.23. /{db}/_missing_revs
    • 1.3.24. /{db}/_revs_diff
    • 1.3.25. /{db}/_revs_limit
  • 1.4. Документы
    • 1.4.1. /{db}/{docid}
    • 1.4.2. /{db}/{docid}/{attname}
  • 1.5. Проектные документы
    • 1.5.1. /{db}/_design/{ddoc}
    • 1.5.2. /{db}/_design/{ddoc}/{attname}
    • 1.5.3. /{db}/_design/{ddoc}/_info
    • 1.5.4. /{db}/_design/{ddoc}/_view/{view}
    • 1.5.5. /{db}/_design/{ddoc}/_search/{index}
    • 1.5.6. /{db}/_design/{ddoc}/_search_info/{index}
    • 1.5.7. /{db}/_design/{ddoc}/_nouveau/{index}
    • 1.5.8. /{db}/_design/{ddoc}/_nouveau_info/{index}
    • 1.5.9. /{db}/_design/{ddoc}/_show/{func}
    • 1.5.10. /{db}/_design/{ddoc}/_show/{func}/{docid}
    • 1.5.11. /{db}/_design/{ddoc}/_list/{func}/{view}
    • 1.5.12. /{db}/_design/{ddoc}/_list/{func}/{other-ddoc}/{view}
    • 1.5.13. /{db}/_design/{ddoc}/_update/{func}
    • 1.5.14. /{db}/_design/{ddoc}/_update/{func}/{docid}
    • 1.5.15. /{db}/_design/{ddoc}/_rewrite/{path}
  • 1.6. Секционированные базы данных
    • 1.6.1. /{db}/_partition/{partition_id}
    • 1.6.2. /{db}/_partition/{partition_id}/_all_docs
    • 1.6.3. /{db}/_partition/{partition_id}/_design/{ddoc}/_view/{view}
    • 1.6.4. /{db}/_partition/{partition_id}/_find
    • 1.6.5. /{db}/_partition/{partition_id}/_explain
  • 1.7. Локальные (не реплицируемые) документы
    • 1.7.1. /{db}/_local_docs
    • 1.7.2. /{db}/_local_docs/queries
    • 1.7.3. /{db}/_local/{docid}

Copyright © 2025 The Apache Software Foundation — Licensed under the Apache License 2.0
https://docs.couchdb.org/en/3.5.1/api/index.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API