sa_describe_query( 
query 
[, add_keys ] 
)

Die sa_describe_query-Prozedur stellt einen API-unabhängigen Mechanismus zur Beschreibung der Namens- und Typinformationen für die Ausdrücke in der Ergebnismenge einer Abfrage zur Verfügung.

Wenn für add_keys "1" angegeben ist, versucht die sa_describe_query-Prozedur, einen Satz von Spalten unter den abgefragten Objekten zu finden, die zusammengefasst als ein Schlüssel für die eindeutige Identifizierung von Zeilen in der Ergebnismenge der zu beschreibenden Abfrage verwendet werden können. Der Schlüssel nimmt die Form einer oder mehrerer Spalten der abgefragten Objekte an und kann auch Spalten umfassen, die von der Abfrage nicht explizit referenziert werden. Wenn der Optimierer einen Schlüssel findet, werden die im Schlüssel verwendeten Spalten in den Ergebnissen mit einem is_key_column-Wert von "1" identifiziert. Wenn kein Schlüssel gefunden wird, wird ein Fehler zurückgegeben.

Bei jeder Spalte, die im Schlüssel enthalten ist, aber in der Abfrage nicht explizit referenziert wird, wird der is_added_key_column-Wert auf "1" gesetzt, um anzudeuten, dass die Spalte den Ergebnissen der Prozedur hinzugefügt wurde. Sonst ist der Wert von is_added_key_column "0".

Wenn Sie keinen add_keys oder einen Wert von "0" angeben, versucht der Optimierer nicht, einen Schlüssel für die Ergebnismenge zu finden, und die Spalten is_key_column und is_added_key_column enthalten NULL.

Die Werte declared_width und width beschreiben beide die Größe einer Spalte. Der declared_width-Wert beschreibt die Größe der Spalte, wie sie von der CREATE TABLE-Anweisung oder der Abfrage definiert wird, während der width-Wert die Größe des Felds angibt, wenn es vom Client abgerufen wird. Die Darstellung eines Typs auf dem Client kann sich von der des Datenbankservers unterscheiden. Datums- und Zeittypen beispielsweise werden in Zeichenfolgen konvertiert, wenn die return_date_time_as_string-Option auf ON gesetzt ist. Bei Zeichenfolgen haben mit Zeichenlängensemantik deklarierte Felder einen declared_width-Wert, der der CREATE TABLE-Größe entspricht, während der width-Wert die maximale Anzahl von Byte angibt, die zum Speichern der zurückgegebenen Zeichenfolge erforderlich sind. Beispiel:

Keine

Keine

• EXPRTYPE-Funktion [Verschiedene]
• Zeichendatentypen
• return_date_time_as_string-Option
• SYSDOMAIN-Systemansicht
• SYSDOMAIN-Systemansicht
• SYSUSERTYPE-Systemansicht
• SYSTAB-Systemansicht
• SYSUSER-Systemansicht

Das folgende Beispiel beschreibt die zurückgegebenen Informationen, wenn alle Spalten in der Departments-Tabelle abgefragt werden:

SELECT *  
FROM sa_describe_query( 'SELECT * FROM Departments DEPT' );

Die Ergebnisse zeigen die Werte der Spalten is_key_column und is_added_key_column als NULL, weil der Parameter add_keys nicht angegeben wurde.

Das folgende Beispiel beschreibt die Informationen, die durch Abfragen der DepartmentName- und Surname-Spalten der Employees-Tabelle, die durch einen Join mit der Departments-Tabelle verknüpft ist, zurückgegeben werden.

SELECT  *
FROM  sa_describe_query( 'SELECT DepartmentName, Surname
 FROM Employees E JOIN Departments D ON E.EmployeeID = D.DepartmentHeadId',
 add_keys = 1 );

Die Ergebnisse enthalten eine 1 in den Zeilen 3 und 4 der Ergebnismenge, was darauf hinweist, dass die Spalten, die zum eindeutigen Identifizieren von Zeilen in der Ergebnismenge benötigt werden, Employees.EmployeeID und Departments.DepartmentID sind. Auch ist 1 der Wert von is_added_key_column für die Zeilen 3 und 4, weil Employees.EmployeeID und Departments.DepartmentID nicht explizit in der zu beschreibenden Abfrage referenziert wurden.