/{db}/{docid}

HEAD /{db}/{docid}

Возвращает HTTP-заголовки, содержащие минимальный объем информации об указанном документе. Метод поддерживает те же аргументы запроса, что и метод GET /{db}/{docid}, но возвращается только информация из заголовков (включая размер документа и ревизию в виде ETag).

Заголовок ETag показывает текущую ревизию запрошенного документа, а Content-Length указывает размер данных, если бы документ был запрошен полностью.

Если добавить любой из аргументов запроса (см. GET /{db}/{docid}), возвращаемые HTTP-заголовки будут соответствовать заголовкам, которые были бы возвращены в ответе.

Параметры:

• db – Имя базы данных

• docid – Идентификатор документа

Заголовки запроса:

• If-None-Match – Токен ревизии документа в двойных кавычках

Заголовки ответа:

• Content-Length – Размер документа

• ETag – Токен ревизии документа в двойных кавычках

Коды состояния:

• 200 OK – Документ существует

• 304 Not Modified – Документ не изменялся после указанной ревизии

• 401 Unauthorized – Требуются права на чтение

• 403 Forbidden – Недостаточно прав / Слишком много запросов с недействительными учетными данными

• 404 Not Found – Документ не найден

Запрос:

HEAD /db/SpaghettiWithMeatballs HTTP/1.1
Accept: application/json
Host: localhost:5984

Ответ:

HTTP/1.1 200 OK
Cache-Control: must-revalidate
Content-Length: 660
Content-Type: application/json
Date: Tue, 13 Aug 2013 21:35:37 GMT
ETag: "12-151bb8678d45aaa949ec3698ef1c7e78"
Server: CouchDB (Erlang/OTP)

GET /{db}/{docid}

Возвращает документ с указанным docid из указанной db. Если не запрашивается конкретная ревизия, всегда возвращается последняя ревизия документа.

Параметры:

• db – Имя базы данных

• docid – Идентификатор документа

Заголовки запроса:

• Accept –

  • application/json

  • multipart/related

  • multipart/mixed

  • text/plain

• If-None-Match – Токен ревизии документа в двойных кавычках

Параметры запроса:

• attachments (boolean) – Включает содержимое вложений в ответ. Значение по умолчанию: false

• att_encoding_info (boolean) – Включает сведения о кодировании в заглушки вложений, если соответствующее вложение сжато. Значение по умолчанию: false.

• atts_since (array) – Включает вложения только начиная с указанных ревизий. Не включает вложения для указанных ревизий. Необязательно

• conflicts (boolean) – Включает сведения о конфликтах в документе. Значение по умолчанию: false

• deleted_conflicts (boolean) – Включает сведения об удаленных конфликтующих ревизиях. Значение по умолчанию: false

• latest (boolean) – Принудительно получает последнюю «листовую» ревизию независимо от того, какая ревизия rev была запрошена. Значение по умолчанию: false

• local_seq (boolean) – Включает последовательность последнего обновления документа. Значение по умолчанию: false

• meta (boolean) – Работает так же, как указание всех параметров запроса conflicts, deleted_conflicts и revs_info. Значение по умолчанию: false

• open_revs (array) – Получает документы указанных листовых ревизий. Кроме того, принимает значение all для возврата всех листовых ревизий. Необязательно

• rev (string) – Получает документ указанной ревизии. Необязательно

• revs (boolean) – Включает список всех известных ревизий документа. Значение по умолчанию: false

• revs_info (boolean) – Включает подробные сведения обо всех известных ревизиях документа. Значение по умолчанию: false

Заголовки ответа:

• Content-Type –

  • application/json

  • multipart/related

  • multipart/mixed

  • text/plain; charset=utf-8

• ETag – Токен ревизии документа в двойных кавычках. Недоступен при получении сведений, связанных с конфликтами

• Transfer-Encoding – chunked. Доступен при запросе с параметром open_revs

Объект JSON ответа:

• _id (string) – Идентификатор документа

• _rev (string) – Токен MVCC ревизии

• _deleted (boolean) – Флаг удаления. Доступен, если документ был удален

• _attachments (object) – Заглушки вложений. Доступны, если у документа есть вложения

• _conflicts (array) – Список конфликтующих ревизий. Доступен при запросе с параметром conflicts=true

• _deleted_conflicts (array) – Список удаленных конфликтующих ревизий. Доступен при запросе с параметром deleted_conflicts=true

• _local_seq (string) – Последовательность обновления документа в текущей базе данных. Доступна при запросе с параметром local_seq=true

• _revs_info (array) – Список объектов со сведениями о локальных ревизиях и их состоянии. Доступен при запросе с параметром open_revs

• _revisions (object) – Список локальных токенов ревизий без. Доступен при запросе с параметром revs=true

Коды состояния:

• 200 OK – Запрос успешно выполнен

• 304 Not Modified – Документ не изменялся после указанной ревизии

• 400 Bad Request – Неверный формат запроса или ревизии

• 401 Unauthorized – Требуются права на чтение

• 403 Forbidden – Недостаточно прав / Слишком много запросов с недействительными учетными данными

• 404 Not Found – Документ не найден

Запрос:

GET /recipes/SpaghettiWithMeatballs HTTP/1.1
Accept: application/json
Host: localhost:5984

Ответ:

HTTP/1.1 200 OK
Cache-Control: must-revalidate
Content-Length: 660
Content-Type: application/json
Date: Tue, 13 Aug 2013 21:35:37 GMT
ETag: "1-917fa2381192822767f010b95b45325b"
Server: CouchDB (Erlang/OTP)

{
    "_id": "SpaghettiWithMeatballs",
    "_rev": "1-917fa2381192822767f010b95b45325b",
    "description": "An Italian-American dish that usually consists of spaghetti, tomato sauce and meatballs.",
    "ingredients": [
        "spaghetti",
        "tomato sauce",
        "meatballs"
    ],
    "name": "Spaghetti with meatballs"
}

PUT /{db}/{docid}

Метод PUT создает новый документ с заданным именем или новую ревизию существующего документа. В отличие от метода POST /{db}, необходимо указать идентификатор документа в URL запроса.

При обновлении существующего документа текущая ревизия документа должна быть включена в документ (то есть в тело запроса), указана как параметр запроса rev или в заголовке запроса If-Match.

Параметры:

• db – Имя базы данных

• docid – Идентификатор документа

Заголовки запроса:

• Accept –

  • application/json

  • text/plain

• Content-Type –

  • application/json

  • multipart/related

• If-Match – Ревизия документа. Альтернатива параметру запроса rev или ключу документа. Необязательно

Параметры запроса:

• rev (string) – Ревизия документа при обновлении существующего документа. Альтернатива заголовку If-Match или ключу документа. Необязательно

• batch (string) – Сохраняет документ в пакетном режиме. Возможные значения: ok. Необязательно

• new_edits (boolean) – Запрещает вставку конфликтующего документа. Возможные значения: true (по умолчанию) и false. Если задано false, в документ необходимо включить корректно сформированный _rev. new_edits=false используется репликатором для вставки документов в целевую базу данных, даже если это приводит к возникновению конфликтов. Необязательно, Значение ``false`` предназначено только для использования репликатором.

Заголовки ответа:

• Content-Type –

  • application/json

  • text/plain; charset=utf-8

  • multipart/related

• ETag – Новая ревизия документа в кавычках

• Location – URI документа

Объект JSON ответа:

• id (string) – Идентификатор документа

• ok (boolean) – Статус операции

• rev (string) – Токен MVCC ревизии

Коды состояния:

• 201 Created – Документ создан и сохранен на диске

• 202 Accepted – Данные документа приняты, но еще не сохранены на диске

• 400 Bad Request – Недопустимое тело запроса или параметры

• 401 Unauthorized – Требуются права на запись

• 403 Forbidden – Недостаточно прав / Слишком много запросов с недействительными учетными данными

• 404 Not Found – Указанная база данных или идентификатор документа не существует

• 409 Conflict – Документ с указанным идентификатором уже существует или указанная ревизия не является последней для целевого документа

Запрос:

PUT /recipes/SpaghettiWithMeatballs HTTP/1.1
Accept: application/json
Content-Length: 196
Content-Type: application/json
Host: localhost:5984

{
    "description": "An Italian-American dish that usually consists of spaghetti, tomato sauce and meatballs.",
    "ingredients": [
        "spaghetti",
        "tomato sauce",
        "meatballs"
    ],
    "name": "Spaghetti with meatballs"
}

Ответ:

HTTP/1.1 201 Created
Cache-Control: must-revalidate
Content-Length: 85
Content-Type: application/json
Date: Wed, 14 Aug 2013 20:31:39 GMT
ETag: "1-917fa2381192822767f010b95b45325b"
Location: http://localhost:5984/recipes/SpaghettiWithMeatballs
Server: CouchDB (Erlang/OTP)

{
    "id": "SpaghettiWithMeatballs",
    "ok": true,
    "rev": "1-917fa2381192822767f010b95b45325b"
}

DELETE /{db}/{docid}

Помечает указанный документ как удаленный, добавляя поле _deleted со значением true. Документы с этим полем больше не возвращаются в ответах на запросы, но остаются в базе данных. Необходимо указать текущую (последнюю) ревизию, используя параметр rev или заголовок If-Match, чтобы указать ревизию.

Примечание

CouchDB не удаляет указанный документ полностью. Вместо этого она оставляет надгробие с самой необходимой информацией о документе. Надгробие требуется для репликации действия удаления между базами данных.

См. также

Получение удаленных документов

Параметры:

• db – Имя базы данных

• docid – Идентификатор документа

Заголовки запроса:

• Accept –

  • application/json

  • text/plain

• If-Match – Ревизия документа. Альтернатива параметру запроса rev

Параметры запроса:

• rev (string) – Текущая ревизия документа

• batch (string) – Сохраняет документ в пакетном режиме. Возможные значения: ok. Необязательно

Заголовки ответа:

• Content-Type –

  • application/json

  • text/plain; charset=utf-8

• ETag – Новая ревизия документа в двойных кавычках

Объект JSON ответа:

• id (string) – Идентификатор документа

• ok (boolean) – Статус операции

• rev (string) – Токен MVCC ревизии

Коды состояния:

• 200 OK – Документ успешно удален

• 202 Accepted – Запрос принят, но изменения еще не сохранены на диске

• 400 Bad Request – Недопустимое тело запроса или параметры

• 401 Unauthorized – Требуются права на запись

• 403 Forbidden – Недостаточно прав / Слишком много запросов с недействительными учетными данными

• 404 Not Found – Указанная база данных или идентификатор документа не существует

• 409 Conflict – Указанная ревизия не является последней для целевого документа

Запрос:

DELETE /recipes/FishStew?rev=1-9c65296036141e575d32ba9c034dd3ee HTTP/1.1
Accept: application/json
Host: localhost:5984

Вместо параметра запроса rev можно использовать заголовок If-Match:

DELETE /recipes/FishStew HTTP/1.1
Accept: application/json
If-Match: 1-9c65296036141e575d32ba9c034dd3ee
Host: localhost:5984

Ответ:

HTTP/1.1 200 OK
Cache-Control: must-revalidate
Content-Length: 71
Content-Type: application/json
Date: Wed, 14 Aug 2013 12:23:13 GMT
ETag: "2-056f5f44046ecafc08a2bc2b9c229e20"
Server: CouchDB (Erlang/OTP)

{
    "id": "FishStew",
    "ok": true,
    "rev": "2-056f5f44046ecafc08a2bc2b9c229e20"
}

COPY /{db}/{docid}

Метод COPY (нестандартный метод HTTP) копирует существующий документ в новый или существующий документ. Копирование документа возможно только в пределах одной базы данных.

Исходный документ указывается в строке запроса, а целевой документ — в заголовке запроса Destination.

Параметры:

• db – Имя базы данных

• docid – Идентификатор документа

Заголовки запроса:

• Accept –

  • application/json

  • text/plain

• Destination – Целевой документ. Должен содержать идентификатор целевого документа и, при копировании в существующий документ, может содержать его ревизию. См. Копирование в существующий документ.

• If-Match – Ревизия исходного документа. Альтернатива параметру запроса rev

Параметры запроса:

• rev (string) – Ревизия, из которой выполняется копирование. Необязательно

• batch (string) – Сохраняет документ в пакетном режиме. Возможные значения: ok. Необязательно

Заголовки ответа:

• Content-Type –

  • application/json

  • text/plain; charset=utf-8

• ETag – Новая ревизия документа в двойных кавычках

• Location – URI документа

Объект JSON ответа:

• id (string) – Идентификатор документа

• ok (boolean) – Статус операции

• rev (string) – Токен MVCC ревизии

Коды состояния:

• 201 Created – Документ успешно создан

• 202 Accepted – Запрос принят, но изменения еще не сохранены на диске

• 400 Bad Request – Недопустимое тело запроса или параметры

• 401 Unauthorized – Требуются права на чтение или запись

• 403 Forbidden – Недостаточно прав / Слишком много запросов с недействительными учетными данными

• 404 Not Found – Указанная база данных, идентификатор документа или ревизия не существуют

• 409 Conflict – Документ с указанным идентификатором уже существует или указанная ревизия не является последней для целевого документа

Запрос:

COPY /recipes/SpaghettiWithMeatballs HTTP/1.1
Accept: application/json
Destination: SpaghettiWithMeatballs_Italian
Host: localhost:5984

Ответ:

HTTP/1.1 201 Created
Cache-Control: must-revalidate
Content-Length: 93
Content-Type: application/json
Date: Wed, 14 Aug 2013 14:21:00 GMT
ETag: "1-e86fdf912560c2321a5fcefc6264e6d9"
Location: http://localhost:5984/recipes/SpaghettiWithMeatballs_Italian
Server: CouchDB (Erlang/OTP)

{
    "id": "SpaghettiWithMeatballs_Italian",
    "ok": true,
    "rev": "1-e86fdf912560c2321a5fcefc6264e6d9"
}