Dokument-IDs

Das Format einer Dokument-ID hängt davon ab, ob eine partitionierte Datenbank verwendet wird. Bei einer partitionierten Datenbank wird der Partitionsschlüssel als Teil der Dokument-ID definiert, wie im nächsten Abschnitt beschrieben.

$PARTITION_KEY:$DOCUMENT_KEY

Einschränkungen für Feldnamen

Feldnamen, die mit dem Unterstreichungszeichen (_) beginnen, sind für IBM Cloudant reserviert. Dies bedeutet, dass Ihre eigenen Feldnamen normalerweise nicht mit einem Unterstreichungszeichen beginnen dürfen. Beispiel: Der Feldname example ist zulässig, aber der Feldname _example verursacht eine Fehlernachricht des Typs doc_validation.

Im folgenden JSON-Beispieldokument wird versucht, ein Feld mit einem Feldnamen zu erstellen, dem ein Unterstrechungszeichen als Präfix vorangestellt ist:

{
	"_top_level_field_name": "some data"
}

Die folgende Fehlernachricht wird zurückgegeben, wenn Sie versuchen, ein Feld mit einem Feldnamen zu erstellen, der mit einem Unterstrichpräfix beginnt:

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

Wenn der Feldname jedoch ein verschachteltes Objekt in dem Dokument bezeichnet, können Sie ein Unterstreichungszeichen als Präfix für den Feldnamen verwenden.

Im folgenden JSON-Beispieldokument wird versucht, einen Feldnamen für ein im Dokument verschachteltes Objekt zu erstellen, der ein Unterstrichpräfix enthält:

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

Das folgende Beispiel zeigt eine gekürzte Erfolgsnachricht für die Erstellung eines verschachtelten Felds, dessen Feldname ein Unterstrichpräfix enthält:

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