Verwenden von erweiterten Eigenschaften für Datenbankobjekte

Definieren erweiterter Eigenschaften

Jede erweiterte Eigenschaft verfügt über einen benutzerdefinierten Namen und einen benutzerdefinierten Wert. Der Wert einer erweiterten Eigenschaft ist vom Typ sql_variant und kann Daten im Umfang von bis zu 7.500 Byte enthalten. Einem einzelnen Objekt können mehrere erweiterte Eigenschaften hinzugefügt werden.

Für das Angeben erweiterter Eigenschaften werden die Objekte in einer SQL Server-Datenbank in drei Ebenen, 0, 1 und 2, unterteilt. Ebene 0 ist die höchste Ebene und als im Datenbankbereich enthaltene Objekte definiert. Objekte der Ebene 1 sind in einem Schema oder Benutzerbereich enthalten, Objekte der Ebene 2 sind in Objekten der Ebene 1 enthalten. Erweiterte Eigenschaften können für Objekte auf jeder dieser Ebenen definiert werden.

Verweise auf ein Objekt einer Ebene müssen mit den Namen der Objekte der höheren Ebene gekennzeichnet werden, die diese besitzen oder enthalten. Wenn Sie z. B. einer Tabellenspalte der Ebene 2 eine erweiterte Eigenschaft hinzufügen, müssen Sie auch den Tabellennamen der Ebene 1 angeben, in der die Spalte enthalten ist, sowie das Schema der Ebene 0, das die Tabelle enthält.

Im folgenden Beispiel wird der erweiterte Eigenschaftenwert 'Minimum inventory quantity.' der SafetyStockLevel-Spalte in der Product-Tabelle hinzugefügt, die im Production -Schema enthalten ist.

USE AdventureWorks;
GO
EXEC sys.sp_addextendedproperty 
@name = N'MS_DescriptionExample', 
@value = N'Minimum inventory quantity.', 
@level0type = N'SCHEMA', @level0name = Production, 
@level1type = N'TABLE',  @level1name = Product,
@level2type = N'COLUMN', @level2name = SafetyStockLevel;
GO

Hinzufügen erweiterter Eigenschaften zu Objekten

Die folgende Tabelle führt die Objekte auf, denen erweiterte Eigenschaften hinzugefügt werden können. Die gültigen Objekttypen der Ebene 0, Ebene 1 und Ebene 2 werden genannt, ebenso wie die Berechtigungen, die zum Hinzufügen, Löschen oder Anzeigen der erweiterten Eigenschaften erforderlich sind.

Aggregat

Asymmetrischer Schlüssel

Assembly

Zertifikat

Vertrag (Service Broker)

Datenbank

Beispiel:

USE AdventureWorks;
GO
EXEC sys.sp_addextendedproperty 
@name = N'MS_DescriptionExample', 
@value = N'AdventureWorks Sample OLTP Database';
GO

Standard

Ereignisbenachrichtigung

Dateigruppen- oder Dateiname

Beispiel:

USE AdventureWorks;
GO
EXEC sys.sp_addextendedproperty 
@name = N'MS_DescriptionExample', 
@value = N'Primary filegroup for the AdventureWorks sample database.', 
@level0type = N'FILEGROUP', @level0name = [PRIMARY];
GO

USE AdventureWorks;
GO
EXEC sys.sp_addextendedproperty 
@name = N'MS_DescriptionExample', 
@value = N'Primary data file for the AdventureWorks sample database.', 
@level0type = N'FILEGROUP', @level0name = [PRIMARY],
@level1type = N'Logical File Name', @level1name = AdventureWorks_Data;
GO

Funktion

Beispiel:

USE AdventureWorks;
GO
EXEC sys.sp_addextendedproperty 
@name = N'MS_DescriptionExample', 
@value = N'Scalar function returning the quantity of inventory for a specified ProductID.', 
@level0type = N'SCHEMA', @level0name = [dbo],
@level1type = N'FUNCTION', @level1name = ufnGetStock;
GO

USE AdventureWorks;
GO
EXEC sys.sp_addextendedproperty 
@name = N'MS_DescriptionExample', 
@value = N'Input parameter. Enter a valid ProductID.', 
@level0type = N'SCHEMA', @level0name = [dbo],
@level1type = N'FUNCTION', @level1name = ufnGetStock,
@level2type = N'PARAMETER', @level2name ='@ProductID';
GO

Nachrichtentyp

Partitionsfunktion

Partitionsschema

Planhinweisliste (plan guide)

Im folgenden Beispiel wurde der Planhinweisliste TemplateGuide1 eine erweiterte Eigenschaft hinzugefügt.

USE AdventureWorks;
GO
EXECUTE sp_addextendedproperty @name=N'PlanGuideGroup', @value = N'MyTest', 
@level0type = N'Plan Guide', @level0name = 'TemplateGuide1';

Prozedur

Ebene	Ebenentyp	Erforderliche Berechtigungen zum Hinzufügen oder Löschen einer erweiterten Eigenschaft	Erforderliche Berechtigungen zum Anzeigen einer erweiterten Eigenschaft	Kommentare
0	SCHEMA oder USER			SCHEMA sollte statt USER verwendet werden. Weitere Informationen finden Sie im Abschnitt zum Vergleich zwischen Schema und Benutzer weiter unten in diesem Thema.
1	PROCEDURE	ALTER für OBJECT der Prozedur Hinweis Nur Mitglieder der festen Serverrolle sysadmin können erweiterte Eigenschaften erweiterten gespeicherten Prozeduren hinzufügen.	Beliebige für OBJECT	Gilt für die folgenden benutzerdefinierten gespeicherten Funktionen: CLR Transact-SQL Replikationsfilter Wenn kein Typ der Ebene 2 angegeben wird, gilt die Eigenschaft für die Prozedur selbst.
2	PARAMETER	ALTER für OBJECT der Prozedur	Beliebige für OBJECT

Warteschlange (Service Broker)

Remotedienstbindung (Service Broker)

Route (Service Broker)

Regel

Schema oder User

Ebene	Ebenentyp	Erforderliche Berechtigungen zum Hinzufügen oder Löschen einer erweiterten Eigenschaft	Erforderliche Berechtigungen zum Anzeigen einer erweiterten Eigenschaft	Kommentare
0	SCHEMA oder USER	ALTER für SCHEMA oder ALTER für USER	Beliebige für APPLICATION ROLE Oder Beliebige für ROLE Oder Beliebige ON USER	Wenn kein Typ der Ebene 1 angegeben wird, gilt die Eigenschaft für das Schema oder den Benutzer selbst. USER kann eine der folgenden Rollen sein: Anwendungsrolle Datenbankrolle SQL Server-Benutzer Windows-Gruppe Windows-Benutzer USER sollte nur verwendet werden, wenn Sie einem Benutzer eine erweiterte Eigenschaft hinzufügen. Wichtig USER als Typ der Ebene 0, der auf Ebene 1 oder Objekten der Ebene 2 definiert ist, wird in einer zukünftigen Version von SQL Server entfernt. Vermeiden Sie die beim Entwickeln neuer Anwendungen das Verwenden dieses Features bei neuen Entwicklungsarbeiten, und planen Sie die Änderung von Anwendungen, die dieses Feature zurzeit verwenden. Verwenden Sie stattdessen SCHEMA als Typ der Ebene 0.
1	Unterschiedlich
2	Unterschiedlich

Dienst (auf Server)

Symmetrischer Schlüssel

Synonym

Tabelle

Beispiel:

USE AdventureWorks;
GO
EXEC sys.sp_addextendedproperty 
@name = N'MS_Description', 
@value = N'Street address information for customers, employees, and vendors.', 
@level0type = N'SCHEMA', @level0name = Person, 
@level1type = N'TABLE',  @level1name = Address;
GO

USE AdventureWorks;
GO
EXEC sys.sp_addextendedproperty 
@name = N'MS_DescriptionExample', 
@value = N'Nonclustered index on StateProvinceID.', 
@level0type = N'SCHEMA', @level0name = Person, 
@level1type = N'TABLE',  @level1name = Address,
@level2type = N'INDEX',  @level2name = IX_Address_StateProvinceID;
GO

Trigger

Typ

Typ

Sicht

XML-Schemaauflistung

Objekte ohne Unterstützung erweiterter Eigenschaften

Für die folgenden Objekte können keine erweiterten Eigenschaften definiert werden:

• Objekte im Datenbankbereich, die nicht in den obigen Tabellen aufgeführt sind. Dies schließt Volltextobjekte ein.

• Objekte außerhalb des Datenbankbereichs wie z. B. HTTP-Endpunkte.

• Unbenannte Objekte wie z. B. Partitionsfunktionsparameter.

• Zertifikate, symmetrische Schlüssel, asymmetrische Schlüssel und Anmeldeinformationen.

• Systemdefinierte Objekte wie z. B. Systemtabellen, Katalogsichten und gespeicherte Systemprozeduren.

Schema im Vergleich zu Benutzer

In früheren SQL Server-Versionen waren Benutzer die Besitzer von Datenbankobjekten, wie Tabellen, Sichten und Triggern. Aus diesem Grund war das Hinzufügen einer erweiterten Eigenschaft zu einem dieser Objekte sowie das Angeben eines Benutzernamens als Typ der Ebene 0 zulässig. Datenbankobjekte sind nun in Schemas enthalten, die unabhängig von den Benutzern sind, die Besitzer der Schemas sind.

Sie sollten beachten, dass eine Mehrdeutigkeit bewirkt werden kann, wenn Sie eine erweiterte Eigenschaft auf ein Datenbankobjekt anwenden und USER als Typ der Ebene 0 angeben.Angenommen, Benutzer Mary besitzt beispielsweise zwei Schemas (Mary und MySchema), und diese Schemas enthalten beide eine Tabelle namens MyTable. Wenn Mary der MyTable-Tabelle eine erweiterte Eigenschaft hinzufügt und @level0type = N'USER', @level0name = Mary angibt, ist nicht eindeutig, auf welche Tabelle die erweiterte Eigenschaft angewendet wird. Aus Gründen der Abwärtskompatibilität wendet SQL Server die Eigenschaft auf die Tabelle im Schema namens Mary an. Weitere Informationen zu Benutzern und Schemas finden Sie unter Trennung von Benutzer und Schema.

Verwenden von Input Mask im Vergleich zu CHECK-Einschränkungen

Sowohl CHECK-Einschränkungen als auch erweiterte Eigenschaften, die eine Eingabemaske bereitstellen, können zum Angeben des Musters von Daten verwendet werden, das für Tabellen- oder Sichtspalten erwartet wird. Die meisten Sites wählen eine der beiden Optionen aus, wenn nicht einer der folgenden Umstände vorliegt:

• Die CHECK-Einschränkungen wurden als Zwischenmeasure verwendet, bis alle Programme, die diese Tabelle verwenden, geändert werden konnten, um die Input Mask-Eigenschaften zu verwenden.

• Die Site unterstützt auch Benutzer, die die Daten mithilfe von Ad-hoc-Tools aktualisieren können, die die erweiterten Eigenschaften nicht lesen.

Der Vorteil der Input Mask-Eigenschaft gegenüber der CHECK-Einschränkung liegt darin, dass die Logik in den Anwendungen angewendet wird. Letztere können informativere Fehler generieren, wenn ein Benutzer Daten bereitstellt, die nicht ordnungsgemäß formatiert sind. Der Nachteil der Input Mask-Eigenschaft besteht darin, dass ein separater Aufruf von fn_listextendedproperty oder sys.extended_properties erforderlich ist, um diese Eigenschaft abzurufen; außerdem muss die Logik zum Erzwingen der Maske in allen Programmen hinzugefügt werden.

Replizieren erweiterter Eigenschaften

Erweiterte Eigenschaften werden nur in der anfänglichen Synchronisierung zwischen dem Verleger und dem Abonnenten repliziert. Wenn Sie eine erweiterte Eigenschaft nach der anfänglichen Synchronisierung hinzufügen oder ändern, wird die Änderung nicht repliziert. Weitere Informationen zum Replizieren von Datenbankobjekten finden Sie unter Veröffentlichen von Daten und Datenbankobjekten.

Verwenden erweiterter Eigenschaften in Anwendungen

Erweiterte Eigenschaften stellen nur einen benannten Speicherort bereit, in dem die Daten gespeichert werden sollen. Alle Anwendungen müssen so geschrieben sein, dass die Eigenschaft abgefragt wird und die entsprechenden Aktionen ausgeführt werden. Beispielsweise wird durch Hinzufügen einer Caption-Eigenschaft zu einer Spalte keine Beschriftung erstellt, die von einer Anwendung angezeigt werden kann. Jede Anwendung muss so geschrieben sein, dass die Beschriftung gelesen und ordnungsgemäß angezeigt wird.

So fügen Sie eine erweiterte Eigenschaft hinzu

• sp_addextendedproperty (Transact-SQL)

So aktualisieren Sie eine erweiterte Eigenschaft

• sp_updateextendedproperty (Transact-SQL)

So löschen Sie eine erweiterte Eigenschaft

• sp_dropextendedproperty (Transact-SQL)

So zeigen Sie eine erweiterte Eigenschaft an

• fn_listextendedproperty (Transact-SQL)

• sys.extended_properties (Transact-SQL)

Siehe auch

Verweis

Konzepte

Andere Ressourcen