Kodowanie typów zdefiniowanych przez użytkownika

The Microsoft.SqlServer.Server.SqlUserDefinedTypeAttribute sets the storage format for the Point UDT to Native.IsByteOrdered is set to true, which guarantees that the results of comparisons are the same in SQL Server as if the same comparison had taken place in managed code.Implementuje UDT System.Data.SqlTypes.INullable interfejs, aby uświadomić UDT null.

Poniższy fragment kodu zawiera atrybuty dla Point UDT.

<Serializable(), SqlUserDefinedTypeAttribute(Format.Native, _
  IsByteOrdered:=True)> _
  Public Structure Point
    Implements INullable

[Serializable]
[Microsoft.SqlServer.Server.SqlUserDefinedType(Format.Native,
  IsByteOrdered=true)]
public struct Point : INullable
{

W poniższym przykładzie is_Null zmienna jest prywatny i przechowuje stan null dla wystąpienie UDT.Kod należy utrzymać odpowiednią wartość dla is_Null.UDT musi także mieć właściwość statyczną o nazwie Null , zwraca wartość null wystąpienie UDT.Dzięki temu UDT zwraca wartość null, jeśli wystąpienie jest w rzeczywistości null w bazie danych.

Private is_Null As Boolean

Public ReadOnly Property IsNull() As Boolean _
   Implements INullable.IsNull
    Get
        Return (is_Null)
    End Get
End Property

Public Shared ReadOnly Property Null() As Point
    Get
        Dim pt As New Point
        pt.is_Null = True
        Return (pt)
    End Get
End Property

private bool is_Null;

public bool IsNull
{
    get
    {
        return (is_Null);
    }
}

public static Point Null
{
    get
    {
        Point pt = new Point();
        pt.is_Null = true;
        return pt;
    }
}

Należy rozważyć tabela, która zawiera punkty schematu (int identyfikator, punkt lokalizacji), gdzie Point jest CLR UDT i następujące kwerendy:

--Query 1
SELECT ID
FROM Points
WHERE NOT (location IS NULL) -- Or, WHERE location IS NOT NULL

--Query 2:
SELECT ID
FROM Points
WHERE location.IsNull = 0

Zarówno kwerendy zwracają identyfikatory punktów o nie-Null Lokalizacje.W kwerendzie 1 normalnej obsługi null jest używany i nie jest wymagane nie deserializacji UDTs.Kwerenda 2, z drugiej strony, ma do deserializacji każdego nie-Null object i wywołują CLR uzyskać wartość IsNull właściwość.Wyraźnie, za pomocą IS NULL będzie wykazywać większą wydajność i nigdy nie powinna powód, aby odczytać IsNull Właściwość UDT z Transact-SQL kodu.

Tak, co jest użycie IsNull Właściwość?Po pierwsze, jest potrzebny do ustalenia, czy wartość jest Null z kodu CLR.Po drugie, serwer musi sposobem sprawdzenia, czy wystąpienie jest Null, dlatego ta właściwość jest używana przez serwer.Po ustali ona jest Null, następnie można użyć, jego macierzystej null obsługi obsługi go

Poniższy fragment kodu ilustruje deklaracja Point klasy, która określa ValidationMethodName z ValidatePoint.

<Serializable(), SqlUserDefinedTypeAttribute(Format.Native, _
  IsByteOrdered:=True, _
  ValidationMethodName:="ValidatePoint")> _
  Public Structure Point

[Serializable]
[Microsoft.SqlServer.Server.SqlUserDefinedType(Format.Native,
  IsByteOrdered=true, 
  ValidationMethodName = "ValidatePoint")]
public struct Point : INullable
{

Jeśli określono metoda sprawdzania poprawności, musi on mieć podpis wygląda podobnie do następującego fragmentu kodu.

Private Function ValidationFunction() As Boolean
    If (validation logic here) Then
        Return True
    Else
        Return False
    End If
End Function

private bool ValidationFunction()
{
    if (validation logic here)
    {
        return true;
    }
    else
    {
        return false;
    }
}

Metoda sprawdzania poprawności mogą mieć dowolny zakres i powinna zostać zwrócona true , jeśli wartość jest prawidłowa, a false inaczej.Jeśli metoda zwraca false lub rzuca przypadku wyjątkowego wartość jest traktowany jako nieprawidłowe i komunikat o błędzie jest wywoływane.

W poniższym przykładzie kodu umożliwia tylko wartości zero lub większa współrzędne x i Y.

Private Function ValidatePoint() As Boolean
    If (_x >= 0) And (_y >= 0) Then
        Return True
    Else
        Return False
    End If
End Function

private bool ValidatePoint()
{
    if ((_x >= 0) && (_y >= 0))
    {
        return true;
    }
    else
    {
        return false;
    }
}

Serwer wywołuje metoda sprawdzania poprawności, gdy serwer wykonuje konwersje, nie po wstawionych danych, ustawiając właściwości poszczególnych lub wstawiane dane za pomocą Transact-SQL WSTAWIĆ instrukcja.

Należy jawnie wywołać metoda sprawdzania poprawności z ustawiające właściwość i analizy metoda, jeśli chcesz, aby metoda sprawdzania poprawności do wykonać we wszystkich sytuacjach.Nie jest to wymagane, a w niektórych przypadkach może nie być pożądane.

Zapewniające, że ValidatePoint wywoływana jest metoda punkt klasy, musisz wywołać ją z analizy metody i procedury właściwość, zestaw x i y wartości współrzędnych.Poniższy fragment kodu przedstawia sposób wywołania ValidatePoint metoda sprawdzania poprawności z analizy funkcja.

<SqlMethod(OnNullCall:=False)> _
Public Shared Function Parse(ByVal s As SqlString) As Point
    If s.IsNull Then
        Return Null
    End If

    ' Parse input string here to separate out points.
    Dim pt As New Point()
    Dim xy() As String = s.Value.Split(",".ToCharArray())
    pt.X = Int32.Parse(xy(0))
    pt.Y = Int32.Parse(xy(1))

    ' Call ValidatePoint to enforce validation
    ' for string conversions.
    If Not pt.ValidatePoint() Then
        Throw New ArgumentException("Invalid XY coordinate values.")
    End If
    Return pt
End Function

[SqlMethod(OnNullCall = false)]
public static Point Parse(SqlString s)
{
    if (s.IsNull)
        return Null;

    // Parse input string to separate out points.
    Point pt = new Point();
    string[] xy = s.Value.Split(",".ToCharArray());
    pt.X = Int32.Parse(xy[0]);
    pt.Y = Int32.Parse(xy[1]);

    // Call ValidatePoint to enforce validation
    // for string conversions.
    if (!pt.ValidatePoint()) 
        throw new ArgumentException("Invalid XY coordinate values.");
    return pt;
}

Poniższy fragment kodu przedstawia sposób wywołania ValidatePoint metoda sprawdzania poprawności z procedur właściwość, zestaw współrzędne x i Y.

Public Property X() As Int32
    Get
        Return (Me._x)
    End Get

    Set(ByVal Value As Int32)
        Dim temp As Int32 = _x
        _x = Value
        If Not ValidatePoint() Then
            _x = temp
            Throw New ArgumentException("Invalid X coordinate value.")
        End If
    End Set
End Property

Public Property Y() As Int32
    Get
        Return (Me._y)
    End Get

    Set(ByVal Value As Int32)
        Dim temp As Int32 = _y
        _y = Value
        If Not ValidatePoint() Then
            _y = temp
            Throw New ArgumentException("Invalid Y coordinate value.")
        End If
    End Set
End Property

    public Int32 X
{
    get
    {
        return this._x;
    }
    // Call ValidatePoint to ensure valid range of Point values.
    set 
    {
        Int32 temp = _x;
        _x = value;
        if (!ValidatePoint())
        {
            _x = temp;
            throw new ArgumentException("Invalid X coordinate value.");
        }
    }
}

public Int32 Y
{
    get
    {
        return this._y;
    }
    set
    {
        Int32 temp = _y;
        _y = value;
        if (!ValidatePoint())
        {
            _y = temp;
            throw new ArgumentException("Invalid Y coordinate value.");
        }
    }
}

Punkt klasa zawiera trzy proste metody obliczania odległość: Odległość, DistanceFrom i DistanceFromXY.Każdy zwraca double Obliczanie odległości od Point na zero, wskaż polecenie odległość od określonego Point, oraz współrzędne x i y do określonej odległości od Point.Odległość i DistanceFrom każdego wywołania DistanceFromXYi przedstawiają sposób zastosowania różnych argumentów dla każdej metoda.

' Distance from 0 to Point.
<SqlMethod(OnNullCall:=False)> _
Public Function Distance() As Double
    Return DistanceFromXY(0, 0)
End Function

' Distance from Point to the specified point.
<SqlMethod(OnNullCall:=False)> _
Public Function DistanceFrom(ByVal pFrom As Point) As Double
    Return DistanceFromXY(pFrom.X, pFrom.Y)
End Function

' Distance from Point to the specified x and y values.
<SqlMethod(OnNullCall:=False)> _
Public Function DistanceFromXY(ByVal ix As Int32, ByVal iy As Int32) _
    As Double
    Return Math.Sqrt(Math.Pow(ix - _x, 2.0) + Math.Pow(iy - _y, 2.0))
End Function

// Distance from 0 to Point.
[SqlMethod(OnNullCall = false)]
public Double Distance()
{
    return DistanceFromXY(0, 0);
}

// Distance from Point to the specified point.
[SqlMethod(OnNullCall = false)]
public Double DistanceFrom(Point pFrom)
{
    return DistanceFromXY(pFrom.X, pFrom.Y);
}

// Distance from Point to the specified x and y values.
[SqlMethod(OnNullCall = false)]
public Double DistanceFromXY(Int32 iX, Int32 iY)
{
    return Math.Sqrt(Math.Pow(iX - _x, 2.0) + Math.Pow(iY - _y, 2.0));
}

Microsoft.SqlServer.Server.SqlMethodAttribute Klasy zawiera atrybuty niestandardowe, które można oznaczyć definicji metody w celu określenia determinism na zachowanie wywołanie null i określić, czy metoda jest mutator.Przyjmowane są wartości domyślne dla tych właściwości i niestandardowy atrybut jest używany tylko w razie potrzeby wartości innej niż domyślna.

W poniższej tabela opisano niektóre odpowiednich Microsoft.SqlServer.Server.SqlMethodAttribute Właściwości, które mogą być używane w metodach UDT i wyświetla ich wartości domyślne.

• DataAccess
  Wskazuje, czy funkcja wymaga dostępu do danych użytkownika przechowywane w lokalnym wystąpienie SQL Server.Wartością domyślną jest DataAccessKind.None.

• IsDeterministic
  Wskazuje, czy funkcja daje takie same wartości wyjściowych tej samej wartości wejściowych i tym samym stanie bazy danych.Wartością domyślną jest false.

• IsMutator
  Wskazuje, czy metoda powoduje zmianę stanu UDT wystąpienie.Wartością domyślną jest false.

• IsPrecise
  Wskazuje, czy funkcja obejmuje niedokładny obliczeń, takich jak ruchomy punkt operacji.Wartością domyślną jest false.

• OnNullCall
  Wskazuje, czy metoda jest wywoływana po null podano argumenty wejściowe odniesienia.Wartością domyślną jest true.

The Microsoft.SqlServer.Server.SqlMethodAttribute.IsMutator property allows you to mark a method that allows a change in the state of an instance of a UDT.Transact-SQL does not allow you to set two UDT properties in the SET clause of one UPDATE statement.Jednak może mieć metoda oznaczone jako mutator, który zmienia dwóch członków.

Poniższa instrukcja zakłada istnienie Triangles UDT, który ma Rotate metoda.Następujące Transact-SQL Instrukcja update wywołuje Rotate metoda:

UPDATE Triangles SET t.RotateY(0.6) WHERE id=5

Rotate Ozdobione metody SqlMethod Ustawienie atrybut IsMutator do true , aby SQL Server można oznaczyć metody, jak metoda mutator.Kod ustawia również OnNullCall do false, która wskazuje na serwerze, metoda zwraca wartość null odniesienia (Nothing w języku Visual Basic) Jeśli parametry wejściowe będą odwołania zerowego.

<SqlMethod(IsMutator:=True, OnNullCall:=False)> _
Public Sub Rotate(ByVal anglex as Double, _
  ByVal angley as Double, ByVal anglez As Double) 
   RotateX(anglex)
   RotateY(angley)
   RotateZ(anglez)
End Sub

[SqlMethod(IsMutator = true, OnNullCall = false)]
public void Rotate(double anglex, double angley, double anglez) 
{
   RotateX(anglex);
   RotateY(angley);
   RotateZ(anglez);
}

Currency UDT jest dołączony do próbek CLR, które mogą być instalowane z SQL Server, począwszy od SQL Server 2005.Informacje dotyczące sposobu instalowania próbek CLR Zobacz Zagadnienia dotyczące instalowania przykładów i przykładowych baz danych programu SQL Server.

Currency UDT obsługuje obsługi kwot pieniędzy w systemie pieniężnej określonej kultury.Należy zdefiniować dwa pola: string dla CultureInfo, określa, kto wystawił waluty (en-us, na przykład) i decimal dla CurrencyValue, kwota pieniędzy.

Chociaż nie jest używany przez serwer do przeprowadzania porównań, Currency implementuje UDT System.IComparable interfejs, który udostępnia pojedynczą metoda System.IComparable.CompareTo.Używany w sytuacjach, gdy pożądane jest, aby dokładnie porównania lub kolejność wartości waluty w hodowlach po stronie klient.

Kod uruchomiony w środowisko CLR porównuje kultury, niezależnie od wartości waluty.Dla Transact-SQL Kod następujące akcje określają porównania:

1. Ustaw IsByteOrdered atrybut na true, która informuje o SQL Server do używania utrwalonej reprezentacja binarna na dysku dla porównań.

2. Użyj Write metoda Currency UDT, aby określić sposób utrwalone UDT na dysku, a więc jak UDT wartości są porównywane i dla Transact-SQL operacji.

3. Zapisz Currency w następującym formacie binarnym UDT:

   1. Zapisz kultury jako ciąg zakodowany UTF-16 bajtów 0-19 z uzupełnienie prawo znakami null.

   2. Użyj 20 bajtów i powyżej zawierają wartości dziesiętne waluty.

uzupełnienie ma na celu zapewnienie kultury jest całkowicie oddzielony od wartości waluty tak, aby po jednym UDT jest porównywany innego w Transact-SQL Kod, bajtów kultury są porównywane bajtów kultury i wartości bajtu waluty są porównywane wartości bajtu waluty.

Kompletny kod dla Currency UDT, wykonaj instrukcje dotyczące instalowania próbek CLR w Zagadnienia dotyczące instalowania przykładów i przykładowych baz danych programu SQL Server.

Currency UDT jest zdefiniowana z następujących atrybutów.

<Serializable(), Microsoft.SqlServer.Server.SqlUserDefinedType( _
    Microsoft.SqlServer.Server.Format.UserDefined, _
    IsByteOrdered:=True, MaxByteSize:=32), _
    CLSCompliant(False)> _
Public Structure Currency
Implements INullable, IComparable, _
Microsoft.SqlServer.Server.IBinarySerialize

[Serializable]
[SqlUserDefinedType(Format.UserDefined, 
    IsByteOrdered = true, MaxByteSize = 32)]
    [CLSCompliant(false)]
    public struct Currency : INullable, IComparable, IBinarySerialize
    {