Использование определяемых пользователем типов данных

Применимо к:SQL Server База данных SQL Azure Управляемый экземпляр SQL Azure Azure Synapse Analytics AnalyticsPlatform System (PDW)

Скачать драйвер OLE DB

SQL Server 2005 (9.x) представил определяемые пользователем типы (определяемые пользователем типы). Определяемые пользователем объекты расширяют систему типов SQL, позволяя хранить объекты и пользовательские структуры данных в базе данных SQL Server. Определяемые пользователем типы данных могут содержать несколько типов данных и могут иметь поведение, отличая их от традиционных типов данных псевдонимов, состоящих из одного типа системных данных SQL Server. Определяемые пользователем типы определяются с помощью любого языка, поддерживаемого средой .NET CLR, который создает поддающийся проверке код. К ним относятся C# и Visual Basic .NET. Данные представляются в виде полей и свойств класса или структуры .NET, а поведения определяются методами класса или структуры.

Пользовательские типы (UDT) можно применять в качестве идентификатора столбцов таблицы, как переменную в пакете Transact-SQL или как аргумент функции Transact-SQL либо хранимой процедуры.

Драйвер OLE DB для SQL Server

Драйвер OLE DB для SQL Server поддерживает пользовательские типы как двоичные типы с метаданными, что позволяет управлять пользовательскими типами как объектами. Столбцы пользовательских типов представляются как DBTYPE_UDT, и их метаданные доступны через основной интерфейс OLE DB IColumnRowset и новый интерфейс ISSCommandWithParameters.

Примечание.

Метод IRowsetFind::FindNextRow не работает с пользовательским типом данных. Если определяемый пользователем тип используется в качестве типа столбца поиска, возвращается значение DB_E_BADCOMPAREOP.

Привязки данных и приведение типов

В следующей таблице описывается привязка и приведение, которое возникает при использовании перечисленных типов данных с определяемой пользователем SQL Server. Столбцы пользовательских типов представляются через OLE DB Driver for SQL Server как тип DBTYPE_UDT. Метаданные можно получать через соответствующие наборы строк схемы, так что можно управлять собственными определенными типами как объектами.

Тип данных	На сервер UDT	На сервер Не пользовательский тип	С сервера UDT	С сервера Не пользовательский тип
DBTYPE_UDT	Поддерживается6	Ошибка1	Поддерживается6	Ошибка5
DBTYPE_BYTES	Поддерживается6	Н/Д2	Поддерживается6	Н/Д2
DBTYPE_WSTR	Поддерживается3,6	Н/Д2	Поддерживается4,6	Н/Д2
DBTYPE_BSTR	Поддерживается3,6	Н/Д2	Поддерживается4	Н/Д2
DBTYPE_STR	Поддерживается3,6	Н/Д2	Поддерживается4,6	Н/Д2
DBTYPE_IUNKNOWN	Не поддерживается	Н/Д2	Не поддерживается	Н/Д2
DBTYPE_VARIANT (VT_UI1 | VT_ARRAY)	Поддерживается6	Н/Д2	Поддерживается4	Н/Д2
DBTYPE_VARIANT (VT_BSTR)	Поддерживается3,6	Н/Д2	Н/П	Н/Д2

¹Если тип сервера, отличный от DBTYPE_UDT, указывается с помощью метода ICommandWithParameters::SetParameterInfo и типом метода доступа является DBTYPE_UDT, то при выполнении инструкции возникает ошибка (DB_E_ERRORSOCCURRED; состояние параметра — DBSTATUS_E_BADACCESSOR). В остальных случаях данные отсылаются на сервер, но сервер возвращает ошибку, указывающую на то, что нет неявного преобразования определяемого пользовательского типа в тип данных параметра.

²Выходит за рамки этой статьи.

³ Происходит преобразование шестнадцатеричной строки в двоичные данные.

⁴ Происходит преобразование двоичных данных в шестнадцатеричную строку.

⁵Во время создания метода доступа или во время выборки может произойти проверка данных. Ошибка — DB_E_ERRORSOCCURRED, состояние привязки устанавливается в значение DBBINDSTATUS_UNSUPPORTEDCONVERSION.

⁶Может использоваться BY_REF.

Типы DBTYPE_NULL и DBTYPE_EMPTY могут быть привязаны только для входных параметров. Они не могут быть привязаны для выходных параметров или результатов. При привязке входных параметров состояние должно быть установлено в значение DBSTATUS_S_ISNULL или DBSTATUS_S_DEFAULT.

Тип DBTYPE_UDT также может быть преобразован в типы DBTYPE_EMPTY и DBTYPE_NULL, но тип DBTYPE_NULL и DBTYPE_EMPTY нельзя преобразовать в тип DBTYPE_UDT. Это правило обеспечивает согласование с DBTYPE_BYTES.

Примечание.

Новый интерфейс ISSCommandWithParameters, наследуемый от интерфейса ICommandWithParameters, используется для работы с пользовательскими типами как с параметрами. Приложения должны использовать этот интерфейс для установки, по крайней мере, атрибута SSPROP_PARAM_UDT_NAME набора свойств DBPROPSET_SQLSERVERPARAMETER для параметров определяемых пользователем типов. Если это не сделано, метод ICommand::Execute возвратит ошибку DB_E_ERRORSOCCURRED. Этот интерфейс и набор свойств описан далее в этой статье.

Если определяемый пользователем тип вставлен в столбец, который недостаточно велик для хранения всех его данных, метод ICommand::Execute вернет S_OK с состоянием DB_E_ERRORSOCCURRED.

Преобразования данных, выполняемые основными службами OLE DB (IDataConvert), неприменимы к типу DBTYPE_UDT. Другие привязки не поддерживаются.

Добавления и изменения для наборов строк OLE DB

OLE DB Driver for SQL Server добавляет новые значения или изменяет многие из основных наборов строк схемы OLE DB.

Набор строк схемы PROCEDURE_PARAMETERS

В набор строк схемы PROCEDURE_PARAMETERS были сделаны следующие добавления.

Имя столбца	Тип	Описание
SS_UDT_CATALOGNAME	DBTYPE_WSTR	Идентификатор трехкомпонентного имени.
SS_UDT_SCHEMANAME	DBTYPE_WSTR	Идентификатор трехкомпонентного имени.
SS_UDT_NAME	DBTYPE_WSTR	Идентификатор трехкомпонентного имени.
SS_UDT_ASSEMBLY_TYPENAME	DBTYPE_WSTR	Полное имя сборки, которое включает имя типа и все идентификационные данные сборки, необходимые для ссылки на сборку из среды CLR.

Набор строк схемы SQL_ASSEMBLIES

Драйвер OLE DB для SQL Server представляет новый набор строк схемы, определенной поставщиком, который описывает зарегистрированные пользовательские типы. Сервер ASSEMBLY может быть указан как тип DBTYPE_WSTR, но он отсутствует в наборе строк. Если значение не задано, то по умолчанию для набора строк будет использоваться текущий сервер. Набор строк схемы SQL_ASSEMBLIES определен в приведенной ниже таблице.

Имя столбца	Тип	Описание
ASSEMBLY_CATALOG	DBTYPE_WSTR	Имя каталога сборки, содержащей тип.
ASSEMBLY_SCHEMA	DBTYPE_WSTR	Имя схемы или имя владельца сборки, содержащей тип. Хотя сборки ограничены базой данных, а не схемой, они все еще имеют владельца, отраженного здесь.
ASSEMBLY_NAME	DBTYPE_WSTR	Имя сборки, содержащей тип.
ASSEMBLY_ID	DBTYPE_UI4	Идентификатор объекта сборки, содержащей тип.
PERMISSION_SET	DBTYPE_WSTR	Значение, определяющее область доступа сборки. Значения включают «SAFE», «EXTERNAL_ACCESS» и «UNSAFE».
ASSEMBLY_BINARY	DBTYPE_BYTES	Двоичное представление сборки.

Набор строк схемы SQL_ASSEMBLIES_ DEPENDENCIES

Драйвер OLE DB для SQL Server представляет новый набор строк схемы, определенной поставщиком, который описывает зависимости сборки указанного сервера. ASSEMBLY_SERVER может быть указан участником как тип DBTYPE_WSTR, но отсутствовать в наборе строк. Если значение не задано, то по умолчанию для набора строк будет использоваться текущий сервер. Набор строк схемы SQL_ASSEMBLY_DEPENDENCIES определен в приведенной ниже таблице.

Имя столбца	Тип	Описание
ASSEMBLY_CATALOG	DBTYPE_WSTR	Имя каталога сборки, содержащей тип.
ASSEMBLY_SCHEMA	DBTYPE_WSTR	Имя схемы или имя владельца сборки, содержащей тип. Хотя сборки ограничены базой данных, а не схемой, они все еще имеют владельца, отраженного здесь.
ASSEMBLY_ID	DBTYPE_UI4	Идентификатор объекта сборки.
REFERENCED_ASSEMBLY_ID	DBTYPE_UI4	Идентификатор объекта сборки, на которую присутствует ссылка.

Набор строк схемы SQL_USER_TYPES

Драйвер OLE DB для SQL Server предоставляет новый набор строк схемы — SQL_USER_TYPES, который описывает момент добавления зарегистрированных пользовательских типов для указанного сервера. UDT_SERVER должен быть указан участником как тип DBTYPE_WSTR, но отсутствовать в наборе строк. Набор строк схемы SQL_USER_TYPES определен в следующей таблице.

Имя столбца	Тип	Описание
UDT_CATALOGNAME	DBTYPE_WSTR	Для столбцов пользовательского типа это свойство содержит строку, представляющую имя каталога, в котором определен этот тип.
UDT_SCHEMANAME	DBTYPE_WSTR	Для столбцов пользовательского типа это свойство содержит строку, представляющую имя схемы, в которой определен этот тип.
UDT_NAME	DBTYPE_WSTR	Имя сборки, содержащей класс определяемого пользователем типа.
UDT_ASSEMBLY_TYPENAME	DBTYPE_WSTR	Полное имя типа (AQN) включает имя типа и префикс пространства имен (если оно задано).

Набор строк схемы COLUMNS

Добавления в наборе строк схемы COLUMNS включают перечисленные ниже столбцы.

Имя столбца	Тип	Описание
SS_UDT_CATALOGNAME	DBTYPE_WSTR	Для столбцов пользовательского типа это свойство содержит строку, представляющую имя каталога, в котором определен этот тип.
SS_UDT_SCHEMANAME	DBTYPE_WSTR	Для столбцов пользовательского типа это свойство содержит строку, представляющую имя схемы, в которой определен этот тип.
SS_UDT_NAME	DBTYPE_WSTR	Имя определяемого пользователем типа.
SS_UDT_ASSEMBLY_TYPENAME	DBTYPE_WSTR	Полное имя типа (AQN) включает имя типа и префикс пространства имен (если оно задано).

Добавления и изменения для наборов свойств OLE DB

OLE DB Driver for SQL Server добавляет новые значения или изменяет многие из основных наборов свойств OLE DB.

Набор свойств DBPROPSET_SQLSERVERPARAMETER

Для поддержки пользовательских типов через OLE DB в драйвере OLE DB для SQL Server реализован новый набор свойств DBPROPSET_SQLSERVERPARAMETER, который содержит указанные ниже значения.

Имя.	Тип	Описание
SSPROP_PARAM_UDT_CATALOGNAME	DBTYPE_WSTR	Идентификатор трехкомпонентного имени. Для параметров определяемого пользователем типа это свойство содержит строку, представляющую имя каталога, в котором определен этот тип.
SSPROP_PARAM_UDT_SCHEMANAME	DBTYPE_WSTR	Идентификатор трехкомпонентного имени. Для параметров определяемого пользователем типа данное свойство содержит строку, представляющую имя схемы, в которой определен этот тип.
SSPROP_PARAM_UDT_NAME	DBTYPE_WSTR	Идентификатор трехкомпонентного имени. Для столбцов определяемого пользователем типа это свойство содержит строку, представляющую однокомпонентное имя определяемого пользователем типа.

Свойство SSPROP_PARAM_UDT_NAME является обязательным. Свойства SSPROP_PARAM_UDT_CATALOGNAME и SSPROP_PARAM_UDT_SCHEMANAME не обязательны. Если какое-либо свойство указывается неправильно, возвращается ошибка DB_E_ERRORSINCOMMAND. Если свойства SSPROP_PARAM_UDT_CATALOGNAME и SSPROP_PARAM_UDT_SCHEMANAME не указаны, то определяемый пользователем тип должен быть определен в той же базе данных и схеме, что и таблица. Если определение определяемого пользователем типа и таблица находятся в разных схемах (но в одной базе данных), то должно быть указано свойство SSPROP_PARAM_UDT_SCHEMANAME. Если определение определяемого пользователем типа находится в другой базе данных, то должны быть указаны свойства SSPROP_PARAM_UDT_CATALOGNAME и SSPROP_PARAM_UDT_SCHEMANAME.

Набор свойств DBPROPSET_SQLSERVERCOLUMN

Для поддержки создания таблиц с помощью интерфейса ITableDefinition драйвер OLE DB для SQL Server добавляет к набору свойств DBPROPSET_SQLSERVERCOLUMN три новых столбца.

Имя	Описание	Тип	Описание
SSPROP_COL_UDT_CATALOGNAME	UDT_CATALOGNAME	VT_BSTR	Для столбцов типа DBTYPE_UDT это свойство содержит строку, указывающую имя каталога, в котором определен определяемый пользователем тип.
SSPROP_COL_UDT_SCHEMANAME	UDT_SCHEMANAME	VT_BSTR	Для столбцов типа DBTYPE_UDT это свойство содержит строку, указывающую имя схемы, в которой определен определяемый пользователем тип.
SSPROP_COL_UDT_NAME	UDT_NAME	VT_BSTR	Для столбцов типа DBTYPE_UDT это свойство содержит строку, указывающую однокомпонентное имя определяемого пользователем типа. Для других типов столбцов это свойство возвращает пустую строку.

Примечание.

Определяемые пользователем типы не отображаются в наборе строк схемы PROVIDER_TYPES. Все столбцы доступны для чтения и записи.

ADO будет ссылаться на эти свойства с помощью соответствующей записи в столбце «Описание».

Свойство SSPROP_COL_UDTNAME является обязательным. Свойства SSPROP_COL_UDT_CATALOGNAME и SSPROP_COL_UDT_SCHEMANAME не обязательны. Если какое-либо свойство указывается неправильно, возвращается ошибка DB_E_ERRORSINCOMMAND.

Если ни свойство SSPROP_PARAM_UDT_CATALOGNAME, ни свойство SSPROP_PARAM_UDT_SCHEMANAME не указаны, то определяемый пользователем тип должен быть определен в той же базе данных и схеме, что и таблица.

Если определение определяемого пользователем типа и таблица находятся в разных схемах (но в одной базе данных), то должно быть указано свойство SSPROP_COL_UDT_SCHEMANAME.

Если определение определяемого пользователем типа находится в другой базе данных, то должны быть указаны свойства SSPROP_COL_UDT_CATALOGNAME и SSPROP_COL_UDT_CATALOGNAME.

Добавления и изменения для интерфейсов OLE DB

OLE DB Driver for SQL Server добавляет новые значения или изменяет многие из основных интерфейсов OLE DB.

Интерфейс ISSCommandWithParameters

Для поддержки пользовательских типов посредством OLE DB в драйвере OLE DB для SQL Server реализовано несколько изменений, включая добавление интерфейса ISSCommandWithParameters. Этот новый интерфейс наследует основной интерфейс OLE DB — ICommandWithParameters. Помимо трех методов, наследуемых от интерфейса ICommandWithParameters — GetParameterInfo, MapParameterNames и SetParameterInfo, — интерфейс ISSCommandWithParameters содержит методы GetParameterProperties и SetParameterProperties, которые используются для обработки серверных типов данных.

Примечание.

Интерфейс ISSCommandWithParameters также задействует возможности новой структуры SSPARAMPROPS.

Интерфейс IColumnsRowset

Помимо интерфейса ISSCommandWithParameters, драйвер OLE DB для SQL Server добавляет новые значения в набор строк, возвращаемый вызовом метода IColumnsRowset::GetColumnRowset, включая указанные ниже.

Имя столбца	Тип	Описание
DBCOLUMN_SS_UDT_CATALOGNAME	DBTYPE_WSTR	Идентификатор имени каталога определяемого пользователем типа.
DBCOLUMN_SS_UDT_SCHEMANAME	DBTYPE_WSTR	Идентификатор имени схемы определяемого пользователем типа.
DBCOLUMN_SS_UDT_NAME	DBTYPE_WSTR	Идентификатор имени определяемого пользователем типа.
DBCOLUMN_SS_ASSEMBLY_TYPENAME	DBTYPE_WSTR	Полное имя сборки, которое включает имя типа и все идентификационные данные сборки, необходимые для ссылки на сборку из среды CLR.

Если столбец DBCOLUMN_TYPE имеет значение DBTYPE_UDT, то серверный столбец пользовательского типа можно отличить от других двоичных типов, изучив добавленные метаданные пользовательского типа, указанные в предыдущей таблице. Если данные частично завершены, то тип сервера является определяемым пользователем типом. Для типов сервера, отличных от определяемых пользователем типов, эти столбцы всегда возвращают значение NULL.

См. также

Возможности драйвера OLE DB для SQL Server
ISSCommandWithParameters (OLE DB)