Einschränkungen für eindeutige Schlüssel in Azure Cosmos DB

  • Artikel

GILT FÜR: NoSQL

Eindeutige Schlüssel fügen einem Azure Cosmos DB-Container eine Datenintegritätsebene hinzu. Eine Richtlinie für eindeutige Schlüssel wird erstellt, wenn Sie einen Azure Cosmos DB-Container erstellen. Mit eindeutigen Schlüsseln stellen Sie die Eindeutigkeit von Werten innerhalb einer logischen Partition sicher. Sie können auch die Eindeutigkeit pro Partitionsschlüssel gewährleisten.

Nachdem Sie einen Container mit einer Richtlinie für eindeutige Schlüssel erstellt haben, wird verhindert, dass innerhalb einer logischen Partition neue oder aktualisierte Kopien vorhandener Elemente erstellt werden (gemäß der Einschränkung für eindeutige Schlüssel). Die Kombination aus Partitionsschlüssel und eindeutigem Schlüssel garantiert die Eindeutigkeit eines Elements innerhalb des Containerbereichs.

Stellen Sie sich beispielsweise einen Azure Cosmos DB-Container mit Email address als Einschränkung für eindeutige Schlüssel und CompanyID als Partitionsschlüssel vor. Wenn Sie die E-Mail-Adresse des Benutzers mit einem eindeutigen Schlüssel konfigurieren, verfügt jedes Element innerhalb einer bestimmten Unternehmens-ID (CompanyID) über eine eindeutige e-Mail-Adresse. Es können keine zwei Elemente mit der gleichen E-Mail-Adresse und dem gleichen Partitionsschlüsselwert erstellt werden. In der API für NoSQL von Azure Cosmos DB werden Elemente als JSON-Werte gespeichert. Bei diesen JSON-Werten wird die Groß- und Kleinschreibung berücksichtigt. Wenn Sie eine Eigenschaft als eindeutigen Schlüssel auswählen, können Sie Werte, bei denen die Groß-/Kleinschreibung beachtet werden muss, für diese Eigenschaft einfügen. Wenn Sie beispielsweise einen eindeutigen Schlüssel für die name-Eigenschaft definiert haben, unterscheidet sich „Gaby“ von „gaby“, und Sie können beide Schreibweisen in den Container einfügen.

Um Elemente mit derselben E-Mail-Adresse, nicht jedoch mit derselben Kombination aus Vorname, Nachname und E-Mail-Adresse, zu erstellen, fügen Sie der Richtlinie für eindeutige Schlüssel weitere Pfade hinzu. Anstelle eines eindeutigen Schlüssels, der nur auf der E-Mail-Adresse basiert, können Sie auch einen eindeutigen Schlüssel mit einer Kombination aus Vorname, Nachname und E-Mail-Adresse erstellen. Dieser Schlüssel wird als einen zusammengesetzter eindeutiger Schlüssel bezeichnet. In diesem Fall ist jede eindeutige Kombination der drei Werte innerhalb einer bestimmten Unternehmens-ID (CompanyID) zulässig.

Der Container kann also beispielsweise Elemente mit den folgenden Werten enthalten, wobei jedes Element der Einschränkung für eindeutige Schlüssel entspricht.

CompanyID Vorname Nachname E-Mail-Adresse
Contoso Helga Kohler gaby@contoso.com
Contoso Helga Kohler gaby@fabrikam.com
Fabrikam Helga Kohler gaby@fabrikam.com
Fabrikam Simon Kohler gaby@fabrikam.com
Fabrikam Kohler gaby@fabraikam.com
Fabrikam gaby@fabraikam.com

Wenn Sie versuchen, ein anderes Element mit den in der vorherigen Tabelle aufgeführten Kombinationen einzufügen, erhalten Sie einen Fehler. Der Fehler weist darauf hin, dass die Einschränkung für eindeutige Schlüssel nicht erfüllt wurde. Sie erhalten als Antwortnachricht Resource with specified ID or name already exists oder Resource with specified ID, name, or unique index already exists.

Definieren eines eindeutigen Schlüssels

Eindeutige Schlüssel können Sie nur beim Erstellen eines Azure Cosmos DB-Containers definieren. Ein eindeutiger Schlüssel ist auf eine logische Partition begrenzt. Wenn Sie den Container im vorherigen Beispiel auf der Grundlage der Postleitzahl partitionieren, können dieselben Elemente in jeder logischen Partition auftreten. Berücksichtigen Sie beim Erstellen eindeutiger Schlüssel die folgenden Eigenschaften:

  • Sie können einen bereits vorhandenen Container nicht für die Verwendung eines anderen eindeutigen Schlüssels aktualisieren. Anders ausgedrückt: Nachdem ein Container mit einer Richtlinie für eindeutige Schlüssel erstellt wurde, kann die Richtlinie nicht mehr geändert werden.

  • Um einen eindeutigen Schlüssel für einen bestehenden Container festzulegen, erstellen Sie einen neuen Container mit der Einschränkung für eindeutige Schlüssel. Verwenden Sie das entsprechende Datenmigrationstool, um die Daten aus dem vorhandenen Container in den neuen Container zu verschieben. Verwenden Sie bei SQL-Containern die Containerkopieraufträge, um Daten zu verschieben. Verwenden Sie für MongoDB-Container „mongoimport.exe“ oder „mongorestore.exe“, um die Daten zu verschieben.

  • Eine Richtlinie für eindeutige Schlüssel kann maximal 16 Pfadwerte enthalten. Die Werte können z. B. /firstName, /lastName und /address/zipCode lauten. Jede Richtlinie für eindeutige Schlüssel kann höchstens 10 Einschränkungen auf eindeutige Schlüssel oder Kombinationen enthalten. Die Kombination aus Vorname, Nachname und E-Mail-Adresse im vorherigen Beispiel ist eine Einschränkung. Diese Einschränkung verwendet drei der 16 möglichen Pfade.

  • Wenn ein Container über eine Richtlinie für eindeutige Schlüssel verfügt, erhöhen sich die Kosten für Anforderungseinheiten (Request Units, RUs) zum Erstellen, Aktualisieren und Löschen eines Elements geringfügig.

  • Eindeutige Schlüssel mit geringer Dichte werden nicht unterstützt. Fehlende Werte für eindeutige Pfade werden als Nullwert behandelt und als solche in die Eindeutigkeitseinschränkung einbezogen. Aus diesem, Grunde kann nur ein einzelnes Element mit Nullwert vorhanden sein, um diese Einschränkung zu erfüllen.

  • Bei den Namen eindeutiger Schlüssel wird die Groß-/Kleinschreibung berücksichtigt. Stellen Sie sich beispielsweise einen Container vor, dessen Einschränkung für eindeutige Schlüssel auf /address/zipcode festgelegt ist. Wenn Ihre Daten ein Feld mit dem Namen ZipCode enthalten, fügt Azure Cosmos DB „null“ als eindeutigen Schlüssel ein, da sich zipcode von ZipCode unterscheidet. Aufgrund der Berücksichtigung der Groß-/Kleinschreibung können die übrigen Datensätze mit „ZipCode“ nicht eingefügt werden, da der duplizierte Nullwert gegen die Einschränkung für eindeutige Schlüssel verstößt.

Nächste Schritte