Microsoft Azure Table Storage Connector

Dieser Adapter ermöglicht die Verbindung zu einem Microsoft Azure Table Storage, um verschiedene Operationen durchzuführen.

Eigenschaften (Properties)

Operation

Vom Adapter ausgeführte Operation

Mögliche Werte:

CreateTable: Legt eine neue Tabelle an
Erforderliche Parameter: tableName
ListTable: Listet alle Tabellen auf
DeleteTable: Löscht eine bereits vorhandene Tabelle
Erforderliche Parameter: tableName
InsertEntity: Fügt die Entität ein, wenn die Entität noch nicht vorhanden ist, oder ersetzt eine bestehende Entität.
Nachdem die Operation erfolgreich ausgeführt wurde, enthält die Tabelle die neue Entität mit den definierten Eigenschaften und die vorherige Entität und ihre Eigenschaften werden ersetzt.
Erforderliche Parameter: tableName, partitionKey, rowKey
InsertBatchEntities: Fügt mehrere Entitäten mit einem Schreibvorgang ein, oder ersetzt bestehende Entitäten. Nutzt die InsertOrReplace-Entität.
Erforderliche Parameter: tableName
RetrieveEntity: Ruft eine einzelne, spezifizierte Entität ab
Erforderliche Parameter: tableName, partitionKey, rowKey
RetrieveAllEntities: Ruft alle Entitäten von einem bestimmten partitionKey ab.
Erforderliche Parameter: tableName, partitionKey
RetrieveRangeEntities: Ruft eine Reihe von Entitäten mit dem partitionKey ab und filtert nach einer Reihe von rowKey-Werten. Der partitionKey-Wert identifiziert eine bestimmte Partition und die rowKey-Werte identifizieren eine Teilmenge der Entitäten dieser Partition.
Erforderliche Parameter: tableName, partitionKey, rowKey, filterCondition
DeleteEntity: Löscht eine einzelne Entität.
Erforderliche Parameter: tableName, partitionKey, rowKey
ModifyEntitiy: Ändert eine Entität und wählt zwischen einer Zusammenführen- und einer Ersetzen-Operation mit der Parameterprüfung replaceExistingItems.
Wenn die Ersetzen-Operation ausgewählt ist (replaceExistingItems="true"), dann bleiben nach der Operation nur die angegebenen Eigenschaften erhalten, alle anderen Eigenschaften werden gelöscht.
Wenn die Zusammenführen-Operation gewählt ist (replaceExistingItems="false"), dann bleiben alle Eigenschaften erhalten und die bereits vorhandenen werden aktualisiert.
Erforderliche Parameter: tableName, partitionKey, rowKey, replaceExistingItems
QuerySubsetOfEntityProperties: Ruft eine Teilmenge von Eigenschaften der Entitäten gemäß eines XML-Inputs ab.
Wenn rowKey und partitionKey angegeben sind, dann werden nur die passenden Eigenschaften der Entitäten abgerufen.
Wenn weder rowKey noch partitionKey angegeben sind, dann werden alle Eigenschaften der Tabellenentitäten abgerufen. Die Ausgabe dieser Operation ist eine XML-Datei, die die Teilmenge der Eigenschaften innerhalb eines übergeordneten Elements für jede zugehörige Entität enthält.
Erforderliche Parameter: tableName, partitionKey, rowKey

Parameter

`Adapter`	Adapter Hauptklasse (nicht ändern!) Mögliche Werte: de.softproject.integration.adapter.microsoft.azure.table.MicrosoftAzureTableStorageAdapter: Hauptklasse (Standard)
`accountName`	Name des Microsoft Azure Kontos Mögliche Werte: Beliebige gültige Zeichenkette, z. B. `softproject`
`accountKey`	Passwort zum Microsoft Azure Konto Mögliche Werte: Beliebige Zeichenkette mit dem von Microsoft Azure bereitgestellten Schlüssel, z. B. `AD9ohFhJ6Hve9ODJEXTw53MjR1tjoUZ8lWfDlw5UFqGMih3VtUCapIwIfEMBmITeShQN9MbCITE4SzxTcGIybw==`
`endPoint`	Azur Cosmos DB Endpunkt
`tableName`	Name der Tabelle, in der die Entitäten gespeichert sind Mögliche Werte: Zeichenkette mit der ID für die neue Tabelle Tabellen-Namen müssen die gleichen Namenskonventionen erfüllen wie Datenbank-IDs. Datenbank-Namen müssen zwischen 1 und 255 Zeichen lang sein und dürfen weder `/ \ # ?` noch ein Leerzeichen enthalten.
`partitionKey`	Element des Primärschlüssels Entitäten mit dem gleichen Partitionsschlüssel können schneller abgefragt und in atomaren Operationen eingefügt/aktualisiert werden. Mögliche Werte: Beliebige Zeichenkette, die den Partitionsschlüssel enthält
`rowKey`	Element des Primärschlüssels Der Zeilenschlüssel einer Entität ist ihre eindeutige Kennung innerhalb einer Partition. Mögliche Werte: Beliebige Zeichenkette, die den Zeilenschlüssel enthält
`filterCondition`	Vergleicht `partitionKey` und `rowKey` Mögliche Werte: EQUAL GREATER_THAN GREATER_THAN_OR_EQUAL LESS_THAN LESS_THAN_OR_EQUAL NOT_EQUAL
`replaceExistingItems`	Gibt an, ob `ModifyEntity` eine Zusammenführen- oder Ersetzen-Operation ausführt. Weitere Informationen auf http://azure.github.io/azure-storage-java/. Mögliche Werte: `true`: Ersetzen-Operation ausführen `false`: Zusammenführen-Operation ausführen

Statuswerte

1

Die Adapter-Operation wurde erfolgreich ausgeführt

-1 Bei der Ausführung des Adapters kam es zu einem Fehler

0

Operation CreateTable: Die Tabelle konnte nicht angelegt werden, aber es wurde weder ein Fehler noch eine Exception zurückgegeben.

Operation DeleteTable: Er angegebene tableName existiert nicht.

Input

Der Adapter erwartet ein XML-Dokument als Input.

Für die InsertEntity-Operation wird eine XML-Datei mit folgender Struktur erwartet:

Erwartete Struktur für die Operation InsertEntity

XML

<?xml version="1.0" encoding="UTF-8"
<Entity>
    <Properties1 name="Department" value="ITAdministration"/>
    <Properties2 name="Address" value="C\Pirandello"/>
    <Properties3 name="Name" value="Paolo"/>
    <Properties4 name="Surname" value="Green"/>
</Entity>

Die Eigenschaft name darf kein geschütztes Wort wie beispielsweise Id sein.

Für die ModifyEntity-Operation wird eine XML-Datei mit folgender Struktur erwartet, Properties mit gleichem Namen und Wert werden aktualisiert:
Erwartete Struktur für die Operation ModifyEntity

XML
```
<?xml version="1.0" encoding="UTF-8" ?>
<Entity>
	<Properties name="Name" value="Carlos" />
</Entity>
```
Für die QueryOfSubsetEntityProperties-Operation wird eine XML-Datei erwartet, in der die erforderlichen Properties spezifiziert sind:
Erwartete Struktur für die Operation QueryOfSubsetEntityProperties

XML
```
<?xml version="1.0" encoding="UTF-8" ?>
<Entity>
	<Property name="Department" />
	<Property name="Surname" />
	<Property name="nonExistingProperty" />
</Entity>
```

Output

Der Adapter gibt je nach ausgeführter Operation unterschiedliche Arten von Dokumenten zurück:

Ausgabe der RetrieveEntity-Operation:

Ausgabe für die Operation RetrieveEntity

XML

<?xml version="1.0" encoding="UTF-8"
<Entity partitionKey="ITEmployee" rowKey="ref-0001">
    <Properties name="Department" value="ITAdministration"/>
    <Properties name="Address" value="C\Pirandello"/>
	<Properties name="Surname" value="Green"/>    
	<Properties name="Name" value="Paolo"/>
</Entity>

Ausgabe der RetrieveAllEntities- und RetrieveRangeEntities-Operation:

Ausgabe für die Operation RetrieveAllEntities und RetrieveRangeEntities

XML

<?xml version="1.0" encoding="UTF-8" ?>
<ListEntities>
	<Entity partitionKey="ITEmployee" rowKey="ref-0001">
		<Properties name="Department" value="ITAdministration" />
		<Properties name="Address" value="C\Pirandello" />
		<Properties name="Surname" value="Green" />
		<Properties name="Name" value="Paolo" />
	</Entity>
	<Entity partitionKey="ITEmployee" rowKey="ref-0002">
		<Properties name="Department" value="Developments" />
		<Properties name="Address" value="C\Francisco" />
		<Properties name="Surname" value="Lopez" />
		<Properties name="Name" value="Luis" />
	</Entity>
	<Entity partitionKey="ITEmployee" rowKey="ref-0003">
		<Properties name="Department" value="Sales" />
		<Properties name="Address" value="C\Espada" />
		<Properties name="Surname" value="Red" />
		<Properties name="Name" value="Paula" />
	</Entity>
</ListEntities>

Ausgabe der QueryOfSubsetEntityProperties-Operation:
Ausgabe für die Operation QueryOfSubsetEntityProperties

XML
```
<?xml version="1.0" encoding="UTF-8" ?>
<ListEntities>
	<Entity>
		<Property partitionKey="ITEmployee" />
		<Property rowKey="ref-0001" />
		<Property name="Department" value="ITAdministration" />
		<Property name="nonExistingProperty" />
		<Property name="Surname" value="Green" />
	</Entity>
</ListEntities>
```
Die beiden Properties partitionKey und rowKey werden immer zurückgegeben, da mit ihnen die Entität eindeutig identifiziert werden kann. Da die Operation in der Lage ist, mehrere Properties von mehr als einem Objekt zurückzugeben, ist es wichtig, die Eigenschaften der dazugehörigen Entität zuzuordnen.