Aggregation

Aggregate AEs werden von Aggregate SQL Functions aufgerufen.

Datenstrukturen

Struktur NZAEAGG_HANDLE: Das Aggregat Handle. Ein undurchsichtiges Handle, das mit Aggregate AE-Funktionen verwendet wird.
Struktur „ NzaeAggAccumulate “: Die Struktur Akkumulieren.
Struktur „ NzaeAggFieldFunctions “: Funktionen zum Lesen und Schreiben von Datensätzen für die Aggregation.
Struktur „ NzaeAggFinalResult “: Die Struktur des Endergebnisses.
Struktur „ NzaeAggInitializeState “: Die InitializeState.
Struktur „ NzaeAggMerge “: Die Merge-Struktur.
Struktur „ NzaeAggMetadata “: NzaeAggMetatadata.
Struktur „ NzaeAggReadOnlyFieldFunctions “: Schreibgeschützte Datensatzfunktionen für die Aggregation.

Funktionen

void nzaeAggClose(NZAEAGG_HANDLE handle): Schließt den Griff, wenn er fertig ist.
NzaeAggRcCode nzaeAggGetEnv(NZAEAGG_HANDLE Handle, const char *name, const char **result): Ruft die AE- oder Systemumgebungsvariable ab. Die Variable AE hat Vorrang.
void nzaeAggGetFirstEnvironmentEntry(NZAEAGG_HANDLE handle, NzaeEnvironmentEntry *entry): Gibt den ersten Umgebungseintrag zurück.
AeUserCode nzaeAggGetLastErrorCode(NZAEAGG_HANDLE Handgriff): Ruft den Code für den zuletzt aufgetretenen Fehler ab.
const char* nzaeAggGetLastErrorText(NZAEAGG_HANDLE -Handle): Ruft den Meldungstext für den zuletzt aufgetretenen Fehler ab.
const char* nzaeAggGetLibraryFullPath(NZAEAGG_HANDLE h, const char *libraryName, bool caseSensitive ): Ruft den Dateipfad für den Bibliotheksnamen ab.
NzaeSharedLibraryInfo* nzaeAggGetLibraryInfo(NZAEAGG_HANDLE h): Gibt NzaeSharedLibraryInfo für die angeforderten Shared Library-Informationen zurück.
NzaeSharedLibraryInfo* nzaeAggGetLibraryProcessInfo(NZAEAGG_HANDLE h): Gibt NzaeSharedLibraryInfo Informationen über die gemeinsam genutzte Bibliothek des Prozesses zurück. Gibt NULL zurück, wenn die AE nicht Remote ist. Das AE-System ist Eigentümer des Speichers aus diesem Aufruf.
bool nzaeAggGetNextEnvironmentEntry(NZAEAGG_HANDLE handle, NzaeEnvironmentEntry *entry): Gibt den nächsten Umgebungseintrag zurück.
int nzaeAggGetNumberOfParameters(NZAEAGG_HANDLE h): Gibt die Anzahl der Parameter zurück.
const char* nzaeAggGetParameter(NZAEAGG_HANDLE h, int index): Gibt den Parameter zurück.
NzaeAggRcCode nzaeAggGetRuntime(NZAEAGG_HANDLE Handle, NzaeRuntime *arg): Ruft Laufzeitinformationen über das AE-Aggregat ab.
NzaeAggType nzaeAggGetType(NZAEAGG_HANDLE Handgriff): Gibt den Aggregationstyp zurück.
NzaeAggRcCode nzaeAggLog(NZAEAGG_HANDLE Handle, NzaeLogLevel level, const char *message): Protokolliert die angegebene Nachricht.
void* nzaeAggNext(NZAEAGG_HANDLE handle, NzaeAggMessageType *messageType ): Ruft die nächste Aggregationsmeldung ab.
NzaeAggRcCode nzaeAggPing(NZAEAGG_HANDLE Handgriff): Zeigt an, dass das AE-Aggregat noch aktiv ist und nicht hängt.
NzaeAggRcCode nzaeAggUpdate(NZAEAGG_HANDLE Handgriff): Aktualisiert das Ergebnis in der Datenbank.
NzaeAggRcCode nzaeAggUserError(NZAEAGG_HANDLE Handle, const char *_template,...): Zeigt an, dass die ZB auf einen Fehlerzustand gestoßen ist.

Aufzählungen

enum NzaeAggMessageType{ NZAEAGG_NOT_SET= -2, NZAEAGG_ERROR= -1, NZAEAGG_END= 0, NZAEAGG_INITIALIZE= 1, NZAEAGG_ACCUMULATE= 2, NZAEAGG_MERGE= 3, NZAEAGG_FINAL_RESULT= 4 }: Aggregierte Nachrichtentypen.
enum NzaeAggRcCode{ NZAEAGG_RC_ERROR= -1, NZAEAGG_RC_NORMAL= 0 }: Rückgabecodes von nzaeAgg.
enum NzaeAggType{ NzaeAggUnknown, NzaeAggGrouped, NzaeAggAnalytic }: Der Aggregat-Funktionstyp.

Detaillierte Beschreibung

Aggregate AEs werden von Aggregate SQL Functions aufgerufen.

Dokumentation der Funktion

void nzaeAggClose(NZAEAGG_HANDLE handle)

Schließt den Griff, wenn er fertig ist.

Parameter:

handle

Der Aggregatgriff.

NzaeAggRcCode nzaeAggGetEnv(NZAEAGG_HANDLE Handle, const char *name, const char **result)

Ruft die AE- oder Systemumgebungsvariable ab. Die Variable AE hat Vorrang.

Parameter:

handle

Der Aggregatgriff.
name
Der Name der Variablen.
result
Der Wert der Ausgangsvariablen oder NULL, falls nicht gefunden.

Rückgabe

NzaeAggRcCode
Der aggregierte Rückgabecode.

void nzaeAggGetFirstEnvironmentEntry(NZAEAGG_HANDLE handle, NzaeEnvironmen-tEntry *entry)

Gibt den ersten Umgebungseintrag zurück.

Parameter:

handle

Der Aggregatgriff.
NzaeEnvironmentEntry entry
Der erste Eintrag.

Auf diesen Funktionsaufruf folgen wiederholte Aufrufe von nzaeGetNextEnvironmentEntry. Das AE-System ist Eigentümer des Speichers für diesen Anruf.

AeUserCode nzaeAggGetLastErrorCode(NZAEAGG_HANDLE Handgriff)

Ruft den Code für den zuletzt aufgetretenen Fehler ab.

Parameter:

handle

Der Aggregatgriff.

Rückgabe

AeUserCode

Der aggregierte Fehlercode.

const char* nzaeAggGetLastErrorText(NZAEAGG_HANDLE -Handle)

Ruft den Meldungstext für den zuletzt aufgetretenen Fehler ab.

Parameter:

handle

Der Aggregatgriff.

Rückgabe

Der Text des letzten Fehlers.

const char* nzaeAggGetLibraryFullPath(NZAEAGG_HANDLE h, const char *libraryName, bool caseSensitive )

Ruft den Dateipfad für den Bibliotheksnamen ab.

Parameter:

h

Der Aggregatgriff.
libraryName

Gibt den Bibliotheksnamen an.
caseSensitive

Wenn TRUE, wird bei der Suche zwischen Groß- und Kleinschreibung unterschieden.

Rückgabe
Der Dateipfad, wenn er gefunden wurde; ansonsten NULL.
Gibt NULL zurück, wenn die Bibliothek nicht gefunden wird. Das AE-System ist Eigentümer des Speichers aus diesem Aufruf.

NzaeSharedLibraryInfo* nzaeAggGetLibraryInfo(NZAEAGG_HANDLE h)

Gibt NzaeSharedLibraryInfo für die angeforderten Shared Library-Informationen zurück.

Parameter:

h

Der Aggregatgriff.

Rückgabe
NzaeSharedLibraryInfo
Die Informationen der Gemeinsamen Bibliothek.

Das AE-System ist Eigentümer des Speichers aus diesem Aufruf.

NzaeSharedLibraryInfo* nzaeAggGetLibraryProcessInfo(NZAEAGG_HANDLE h)

Gibt NzaeSharedLibraryInfo Informationen über die gemeinsam genutzte Bibliothek des Prozesses zurück. Gibt NULL zurück, wenn die AE nicht Remote ist. Das AE-System ist Eigentümer des Speichers aus diesem Aufruf.

Parameter:

h

Der Aggregatgriff.

Rückgabe
NzaeSharedLibraryInfo
Die Informationen der Gemeinsamen Bibliothek.

bool nzaeAggGetNextEnvironmentEntry(NZAEAGG_HANDLE handle, NzaeEnvironmentEntry *entry)

Gibt den nächsten Umgebungseintrag zurück.

Parameter:

handle

Der Aggregatgriff.
NzaeEnvironmentEntry entry
Der nächste Eintrag.

Rückgabe
FALSE am Ende.
Die Informationen der Gemeinsamen Bibliothek.

Der erste nzaeGetNextEnvironmentEntry muss auf einen Aufruf von nzaeGetFirstEnvironmentEntry folgen. Gibt am Ende FALSE zurück. Schlüsselnamen können sich wiederholen, aber die aktuelle Version eines Schlüsselnamens wird zuletzt angegeben. Das AE-System ist Eigentümer des Speichers aus diesem Aufruf.

int nzaeAggGetNumberOfParameters(NZAEAGG_HANDLE h)

Gibt die Anzahl der Parameter zurück.

Parameter:

h

Der Aggregatgriff.

Rückgabe
Die Anzahl der Parameter.

const char* nzaeAggGetParameter(NZAEAGG_HANDLE h, int index)

Gibt den Parameter zurück.

Parameter:

h

Der Aggregatgriff.
index
Der Parameterindex.

Rückgabe
Der Wert des Parameters.
Der Index ist nullbasiert.

NzaeAggRcCode nzaeAggGetRuntime(NZAEAGG_HANDLE Handle, NzaeRuntime *arg)

Ruft Laufzeitinformationen über das AE-Aggregat ab.

Parameter:

h

Der Aggregatgriff.
NzaeRuntime arg
Die vom Aufrufer erstellte Laufzeit, die ausgefüllt werden muss.

Rückgabe
NzaeAggRcCode
Der aggregierte Rückgabecode.

const char* nzaeAggGetSystemLogFileName(

Ruft den Namen der AE Aggregate System Log File ab.

Rückgabe

Der Name der Protokolldatei.

NzaeAggType nzaeAggGetType(NZAEAGG_HANDLE Handgriff)

Gibt den Aggregationstyp zurück.

Parameter:

handle

Der Aggregatgriff.

Rückgabe
NzaeAggType
Der Aggregattyp.

NzaeAggRcCode nzaeAggLog(NZAEAGG_HANDLE Handle, NzaeLogLevel level, const char *message)

Protokolliert die angegebene Nachricht.

Parameter:

handle

Der Aggregatgriff.
NzaeLogLevel level
Die Protokollebene.
message
Die Logmeldung.

Rückgabe
NzaeAggRcCode
Der aggregierte Rückgabecode.

void* nzaeAggNext(NZAEAGG_HANDLE handle, NzaeAggMessageType *messageType )

Ruft die nächste Aggregationsmeldung ab.

Parameter:

handle

Der Aggregatgriff.
NzaeAggMessageType messageType
Der zurückgegebene Nachrichtentyp.

Rückgabe

Die Struktur als void * .

Liefert einen NzaeAggInitialize, NzaeAggAccumulate, NzaeAggMerge oder NzaeAggFinalResult. Verwenden Sie den Parameter messageType, um den Rückgabetyp, das Ende der Eingabe und den Fehler zu bestimmen. Gibt im Fehlerfall oder am Ende der Daten NULL zurück.

NzaeAggRcCode nzaeAggPing(NZAEAGG_HANDLE Handgriff)

Zeigt an, dass das AE-Aggregat noch aktiv ist und nicht hängt.

Parameter:

handle

Der Aggregatgriff.

Rückgabe

NzaeAggRcCode

Der aggregierte Rückgabecode.

NzaeAggRcCode nzaeAggUpdate(NZAEAGG_HANDLE Handgriff)

Aktualisiert das Ergebnis in der Datenbank.

Parameter:

handle

Der Aggregatgriff.

Rückgabe

NzaeAggRcCode

Ein NzaeAggInitialize, NzaeAggAccumulate, NzaeAggMerge oder NzaeAggFinalResult Strukturzeiger. Kann im Fehlerfall NULL sein.

NzaeAggRcCode nzaeAggUserError(NZAEAGG_HANDLE Handle, const char *_template,...)

Zeigt an, dass die ZB auf einen Fehlerzustand gestoßen ist.

Parameter:

handle

Der Aggregatgriff.
_template
Die Vorlage im Stil von printf.

Rückgabe

NzaeAggRcCode

Die AE ist abgeschlossen und sollte nach diesem Aufruf beendet werden. Die Nachricht ist wie printf aufgebaut.

Dokumentation der Aufzählungstypen

enum NzaeAggMessageType

Aggregierte Nachrichtentypen.

NZAEAGG_NICHT_GESETZT

NZAEAGG_FEHLER

NZAEAGG_END

NZAEAGG_INITIALISIEREN

NZAEAGG_AKKUMULIEREN

NZAEAGG_ZUSAMMENFÜHREN

NZAEAGG_ENDGÜLTIGES_ERGEBNIS

enum NzaeAggRcCode

Rückgabecodes von nzaeAgg.

NZAEAGG_RC_FEHLER

NZAEAGG_RC_NORMAL

enum NzaeAggType

Der Aggregat-Funktionstyp.

NzaeAggUnknown

NzaeAggGrouped

NzaeAggAnalytic