ID de document

Le format d'un ID de document varie selon qu'une base de données est partitionnée ou non. Lorsqu'une base de données est partitionnée, la clé de partitionnement pour chaque document est définie dans l'ID de document, comme détaillé dans la section suivante.

$PARTITION_KEY:$DOCUMENT_KEY

Restrictions relatives aux noms de zone

Les noms de zone qui commencent par un trait de soulignement (_) sont réservés dans IBM Cloudant. Etant donné cette règle, vous ne pouvez pas utiliser vos propres noms de zone commençant par un trait de soulignement. Par exemple, le nom de zone example est admis, mais le nom de zone _example génère un message d'erreur de type doc_validation.

Voici un exemple de document JSON qui tente de créer une zone avec un trait de soulignement comme préfixe :

{
	"_top_level_field_name": "some data"
}

Voici le message d'erreur qui est renvoyé lorsque vous tentez de créer une zone avec un trait de soulignement comme préfixe :

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

Cependant, si le nom de zone est celui d'un objet imbriqué dans le document, vous pouvez utiliser un trait de soulignement comme préfixe dans le nom de zone.

Voici un exemple de document JSON qui tente de créer une zone avec un trait de soulignement comme préfixe imbriquée dans un objet :

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

Voici un exemple de message de réussite (abrégé) renvoyé lorsqu'un nom de zone imbriqué comportant un trait de soulignement comme préfixe est créé :

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