Bagikan melalui

Fungsi bernilai tabel CLR

Berlaku untuk:SQL Server

Fungsi bernilai tabel adalah fungsi yang ditentukan pengguna yang mengembalikan tabel.

SQL Server memperluas fungsionalitas fungsi bernilai tabel dengan memungkinkan Anda menentukan fungsi bernilai tabel dalam bahasa terkelola apa pun. Data dikembalikan dari fungsi bernilai tabel melalui objek IEnumerable atau IEnumerator.

Untuk fungsi bernilai tabel, kolom jenis tabel yang dikembalikan tidak dapat menyertakan kolom tanda waktu atau kolom tipe data string non-Unicode (sepertikarakter , varchar, dan teks ). Batasan NOT NULL tidak didukung.

Perbedaan antara fungsi bernilai tabel Transact-SQL dan CLR

Fungsi bernilai tabel Transact-SQL mewujudkan hasil pemanggilan fungsi ke dalam tabel perantara. Karena menggunakan tabel perantara, mereka dapat mendukung batasan dan indeks unik atas hasilnya. Fitur-fitur ini dapat berguna ketika hasil besar dikembalikan.

Sebaliknya, fungsi bernilai tabel common language runtime (CLR) mewakili alternatif streaming. Tidak ada persyaratan bahwa seluruh set hasil diwujudkan dalam satu tabel. Objek IEnumerable yang dikembalikan oleh fungsi terkelola secara langsung dipanggil oleh rencana eksekusi kueri yang memanggil fungsi bernilai tabel, dan hasilnya dikonsumsi secara bertambah bertahas. Model streaming ini memastikan bahwa hasil dapat dikonsumsi segera setelah baris pertama tersedia, alih-alih menunggu seluruh tabel diisi. Ini juga merupakan alternatif yang lebih baik jika Anda memiliki sejumlah besar baris yang dikembalikan, karena tidak harus diwujudkan dalam memori secara keseluruhan. Misalnya, fungsi bernilai tabel terkelola dapat digunakan untuk mengurai file teks dan mengembalikan setiap baris sebagai baris.

Menerapkan fungsi bernilai tabel

Terapkan fungsi bernilai tabel sebagai metode pada kelas dalam rakitan .NET Framework. Kode fungsi bernilai tabel Anda harus menerapkan antarmuka IEnumerable. Antarmuka IEnumerable ditentukan dalam .NET Framework. Jenis yang mewakili array dan koleksi dalam .NET Framework sudah mengimplementasikan antarmuka IEnumerable. Ini memudahkan penulisan fungsi bernilai tabel yang mengonversi koleksi atau array menjadi kumpulan hasil.

Parameter bernilai tabel

Parameter bernilai tabel adalah jenis tabel yang ditentukan pengguna yang diteruskan ke prosedur atau fungsi dan menyediakan cara yang efisien untuk meneruskan beberapa baris data ke server. Parameter bernilai tabel menyediakan fungsionalitas yang sama dengan array parameter, tetapi menawarkan fleksibilitas yang lebih besar dan integrasi yang lebih dekat dengan Transact-SQL. Mereka juga memberikan potensi performa yang lebih baik.

Parameter bernilai tabel juga membantu mengurangi jumlah perjalanan pulang pergi ke server. Alih-alih mengirim beberapa permintaan ke server, seperti dengan daftar parameter skalar, data dapat dikirim ke server sebagai parameter bernilai tabel. Jenis tabel yang ditentukan pengguna tidak dapat diteruskan sebagai parameter bernilai tabel ke, atau dikembalikan dari, prosedur tersimpan terkelola atau fungsi yang dijalankan dalam proses SQL Server. Untuk informasi selengkapnya tentang parameter bernilai tabel, lihat Menggunakan parameter bernilai tabel (Mesin Database).

Parameter output dan fungsi bernilai tabel

Informasi mungkin dikembalikan dari fungsi bernilai tabel menggunakan parameter output. Parameter yang sesuai dalam fungsi kode implementasi bernilai tabel harus menggunakan parameter referensi pass-by sebagai argumen. Visual Basic .NET tidak mendukung parameter output dengan cara yang sama seperti C#. Anda harus menentukan parameter berdasarkan referensi dan menerapkan atribut <Out()> untuk mewakili parameter output, seperti dalam contoh berikut:

Imports System.Runtime.InteropServices
...
Public Shared Sub FillRow ( <Out()> ByRef value As SqlInt32)

Menentukan fungsi bernilai tabel di Transact-SQL

Sintaks untuk menentukan fungsi bernilai tabel CLR mirip dengan fungsi Transact-SQL bernilai tabel, dengan penambahan klausa EXTERNAL NAME. Contohnya:

CREATE FUNCTION GetEmpFirstLastNames()
RETURNS TABLE (
    FirstName NVARCHAR (4000),
    LastName NVARCHAR (4000)
)
AS EXTERNAL NAME MyDotNETAssembly.[MyNamespace.MyClassname].GetEmpFirstLastNames;

Fungsi bernilai tabel digunakan untuk mewakili data dalam bentuk relasional untuk pemrosesan lebih lanjut dalam kueri seperti:

SELECT *
FROM func();

SELECT *
FROM tbl
     INNER JOIN func() AS f
         ON tbl.col = f.col;

SELECT *
FROM tbl AS t
CROSS APPLY func(t.col);

Fungsi bernilai tabel dapat mengembalikan tabel saat:

  • Dibuat dari argumen input skalar. Misalnya, fungsi bernilai tabel yang mengambil string angka yang dibatasi koma dan mempivotnya ke dalam tabel.

  • Dihasilkan dari data eksternal. Misalnya, fungsi bernilai tabel yang membaca log peristiwa dan mengeksposnya sebagai tabel.

Catatan

Fungsi bernilai tabel hanya dapat melakukan akses data melalui kueri Transact-SQL dalam metode InitMethod, dan bukan dalam metode FillRow. InitMethod harus ditandai dengan properti atribut SqlFunction.DataAccess.Read jika kueri Transact-SQL dilakukan.

Contoh fungsi bernilai tabel

Fungsi bernilai tabel berikut mengembalikan informasi dari log peristiwa sistem. Fungsi ini mengambil argumen string tunggal yang berisi nama log peristiwa untuk dibaca.

Kode sampel

using System;
using System.Data.Sql;
using Microsoft.SqlServer.Server;
using System.Collections;
using System.Data.SqlTypes;
using System.Diagnostics;

public class TabularEventLog
{
    [SqlFunction(FillRowMethodName = "FillRow")]
    public static IEnumerable InitMethod(String logname)
    {
        return new EventLog(logname).Entries;
    }

    public static void FillRow(Object obj, out SqlDateTime timeWritten, out SqlChars message, out SqlChars category, out long instanceId)
    {
        EventLogEntry eventLogEntry = (EventLogEntry)obj;
        timeWritten = new SqlDateTime(eventLogEntry.TimeWritten);
        message = new SqlChars(eventLogEntry.Message);
        category = new SqlChars(eventLogEntry.Category);
        instanceId = eventLogEntry.InstanceId;
    }
}

Mendeklarasikan dan menggunakan contoh fungsi bernilai tabel

Setelah contoh fungsi bernilai tabel dikompilasi, fungsi dapat dideklarasikan dalam Transact-SQL seperti ini:

USE master;
-- Replace SQL_Server_logon with your SQL Server user credentials.

GRANT EXTERNAL ACCESS ASSEMBLY TO [SQL_Server_logon];

-- Modify the following line to specify a different database.
ALTER DATABASE master
SET TRUSTWORTHY ON;

-- Modify the next line to use the appropriate database.
CREATE ASSEMBLY tvfEventLog
    FROM 'D:\assemblies\tvfEventLog\tvfeventlog.dll'
    WITH PERMISSION_SET = EXTERNAL_ACCESS;
GO

CREATE FUNCTION ReadEventLog
(@logname NVARCHAR (100))
RETURNS TABLE (
    logTime DATETIME,
    Message NVARCHAR (4000),
    Category NVARCHAR (4000),
    InstanceId BIGINT)
AS EXTERNAL NAME tvfEventLog.TabularEventLog.InitMethod;
GO

Objek database Visual C++ yang dikompilasi dengan /clr:pure tidak didukung untuk eksekusi di SQL Server. Misalnya, objek database tersebut menyertakan fungsi bernilai tabel.

Untuk menguji sampel, coba kode Transact-SQL berikut:

-- Select the top 100 events,
SELECT TOP 100 *
FROM dbo.ReadEventLog(N'Security') AS T;
GO

-- Select the last 10 login events.
SELECT TOP 10 T.logTime,
              T.Message,
              T.InstanceId
FROM dbo.ReadEventLog(N'Security') AS T
WHERE T.Category = N'Logon/Logoff';
GO

Contoh

Sampel kode dalam artikel ini menggunakan database sampel AdventureWorks2025 atau AdventureWorksDW2025, yang dapat Anda unduh dari halaman beranda Sampel dan Proyek Komunitas Microsoft SQL Server.

Sebuah. Mengembalikan hasil kueri SQL Server

Contoh berikut menunjukkan fungsi bernilai tabel yang meminta database SQL Server.

Beri nama file kode sumber Anda FindInvalidEmails.cs atau FindInvalidEmails.vb.

using System;
using System.Collections;
using System.Data;
using System.Data.SqlClient;
using System.Data.SqlTypes;

using Microsoft.SqlServer.Server;

public partial class UserDefinedFunctions {
   private class EmailResult {
      public SqlInt32 CustomerId;
      public SqlString EmailAddress;

      public EmailResult(SqlInt32 customerId, SqlString emailAddress) {
         CustomerId = customerId;
         EmailAddress = emailAddress;
      }
   }

   public static bool ValidateEmail(SqlString emailAddress) {
      if (emailAddress.IsNull)
         return false;

      if (!emailAddress.Value.EndsWith("@adventure-works.com"))
         return false;

      // Validate the address. Put any more rules here.
      return true;
   }

   [SqlFunction(
       DataAccess = DataAccessKind.Read,
       FillRowMethodName = "FindInvalidEmails_FillRow",
       TableDefinition="CustomerId int, EmailAddress nvarchar(4000)")]
   public static IEnumerable FindInvalidEmails(SqlDateTime modifiedSince) {
      ArrayList resultCollection = new ArrayList();

      using (SqlConnection connection = new SqlConnection("context connection=true")) {
         connection.Open();

         using (SqlCommand selectEmails = new SqlCommand(
             "SELECT " +
             "[CustomerID], [EmailAddress] " +
             "FROM [AdventureWorksLT2022].[SalesLT].[Customer] " +
             "WHERE [ModifiedDate] >= @modifiedSince",
             connection)) {
            SqlParameter modifiedSinceParam = selectEmails.Parameters.Add(
                "@modifiedSince",
                SqlDbType.DateTime);
            modifiedSinceParam.Value = modifiedSince;

            using (SqlDataReader emailsReader = selectEmails.ExecuteReader()) {
               while (emailsReader.Read()) {
                  SqlString emailAddress = emailsReader.GetSqlString(1);
                  if (ValidateEmail(emailAddress)) {
                     resultCollection.Add(new EmailResult(
                         emailsReader.GetSqlInt32(0),
                         emailAddress));
                  }
               }
            }
         }
      }

      return resultCollection;
   }

   public static void FindInvalidEmails_FillRow(
       object emailResultObj,
       out SqlInt32 customerId,
       out SqlString emailAddress) {
      EmailResult emailResult = (EmailResult)emailResultObj;

      customerId = emailResult.CustomerId;
      emailAddress = emailResult.EmailAddress;
   }
};

Kompilasi kode sumber ke DLL dan salin DLL ke direktori akar drive C Anda. Kemudian, jalankan kueri Transact-SQL berikut.

USE AdventureWorksLT2022;
GO

IF EXISTS (SELECT name
           FROM sysobjects
           WHERE name = 'FindInvalidEmails')
    DROP FUNCTION FindInvalidEmails;
GO

IF EXISTS (SELECT name
           FROM sys.assemblies
           WHERE name = 'MyClrCode')
    DROP ASSEMBLY MyClrCode;
GO

CREATE ASSEMBLY MyClrCode
    FROM 'C:\FindInvalidEmails.dll'
    WITH PERMISSION_SET = SAFE;
GO

CREATE FUNCTION FindInvalidEmails
(@ModifiedSince DATETIME)
RETURNS TABLE (
    CustomerId INT,
    EmailAddress NVARCHAR (4000))
AS EXTERNAL NAME MyClrCode.UserDefinedFunctions.[FindInvalidEmails];
GO

SELECT *
FROM FindInvalidEmails('2000-01-01');
GO
  • Last updated on