IDs de documento

O formato de um ID do documento difere dependendo se um banco de dados é particionado ou não. Quando um banco de dados é particionado, a chave de partição para cada documento é definida como parte do ID do documento, conforme detalhado na próxima seção.

$PARTITION_KEY:$DOCUMENT_KEY

Restrições de nome de campo

Os nomes de campo que começam com o caractere sublinhado (_) são reservados no IBM Cloudant. Essa regra significa que normalmente não é possível ter seus próprios nomes de campo começando com um sublinhado. Por exemplo, o campo example seria aceito, mas o campo _example resultaria em uma mensagem de erro doc_validation.

Veja um exemplo de um documento JSON que tenta criar um campo com um prefixo sublinhado:

{
	"_top_level_field_name": "some data"
}

Veja uma mensagem de erro que é retornada quando você tenta criar um campo com um prefixo sublinhado:

{
	"error": "doc_validation",
	"reason": "Bad special document member: _top_level_field_name"
}

No entanto, se o nome do campo for destinado a um objeto aninhado dentro do documento, será possível usar um prefixo sublinhado para o nome do campo.

Veja um exemplo de um documento JSON que tenta criar um campo com um prefixo sublinhado, aninhado dentro de um objeto:

{
	"another_top_level_field_name": "some data",
	"another_field": {
		"_lower_level_field_name": "some more data"
	}
}

Veja uma mensagem de sucesso de exemplo (abreviada) retornada quando um campo aninhado com um prefixo sublinhado é criado:

{
	"ok": true,
	"id": "2",
	"rev": "1-9ce...8d4"
}