ID de documento

El formato de un ID de documento difiere en función de si una base de datos está particionada o no. Cuando una base de datos está particionada, la clave de partición para cada documento se define como parte del ID del documento tal como se detalla en la sección siguiente.

$PARTITION_KEY:$DOCUMENT_KEY

Restricciones de los nombres de campo

Los nombres de campo que empiezan por el carácter de subrayado (_) están reservados en IBM Cloudant. Esta regla significa que normalmente no puede tener sus propios nombres de campo que comiencen con un carácter de subrayado. Por ejemplo, el campo example se aceptaría, pero el campo _example daría como resultado un mensaje de error doc_validation.

Consulte un ejemplo de documento JSON que intenta crear un campo con un prefijo de subrayado:

{
	"_top_level_field_name": "some data"
}

Consulte un mensaje de error que se devuelve cuando se intenta crear un campo con un prefijo de subrayado:

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

Sin embargo, si el nombre del campo es para un objeto que está anidado en el documento, puede utilizar un prefijo de subrayado para el nombre del campo.

Consulte un ejemplo de documento JSON que intenta crear un campo con un prefijo de subrayado, anidado dentro de un objeto:

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

Consulte un ejemplo de mensaje de éxito (abreviado) que se devuelve cuando se crea un campo anidado con un prefijo de subrayado:

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