IProcedure

Сборка: Db;

Пространство имен: Prognoz.Platform.Interop.Db;

Описание

Интерфейс IProcedure содержит свойства и методы объекта репозитория - Процедура.

Иерархия наследования

          ISQLCommand

          IProcedure

Комментарии

При создании новой процедуры для её корректной работы необходимо, чтобы в настройках был задан следующий минимальный набор свойств:

• Database;

• NativeName;

• Text.

Для выполнения процедуры и получения результатов откройте объект репозитория с помощью метода IMetabaseObjectDescriptor.Open или IMetabaseObjectDescriptor.OpenWithParam и приведите его к интерфейсу ISQLCommandInstance. Если процедура параметрическая, то набор параметров для открытия можно сформировать с помощью метода IMetabaseObjectParams.CreateEmptyValues. Параметры, имеющие тип «Выходной» или «Результат функции», будут доступны в созданном наборе параметров после выполнения метода ISQLCommandInstance.Execute.

При создании в репозитории объекта Процедура на сервере СУБД будет создана хранимая процедура/функция. С ней также можно работать с помощью ресурсов сборки DAL, пример использования приведён в статье «Выполнение хранимых процедур и функций».

Примечание. При выполнении большого количества процедур, а также процедур с выходными параметрами, рекомендуется использовать ресурсы сборки DAL, а не интерфейс ISQLCommandInstance.

Свойства

	Имя свойства	Краткое описание
	External	Свойство External возвращает признак присоединенной процедуры.
	ForceCreate	Свойство ForceCreate определяет возможность создания некорректной процедуры.
	Kind	Свойство Kind позволяет определить тип создаваемого объекта: функция или процедура.
	NativeName	Свойство NativeName определяет физическое имя процедуры в базе данных.

Свойства, унаследованные от ISQLCommand

	Имя свойства	Краткое описание
	Database	Свойство Database определяет базу данных, в которой хранится команда СУБД.
	Text	Свойство Text определяет текст SQL-запроса для определенного драйвера СУБД.

Методы

	Имя метода	Краткое описание
	AlterProcedure	Метод AlterProcedure обновляет текст процедуры в базе данных в соответствии с текстом процедуры в репозитории.
	AttachProcedure	Метод AttachProcedure обновляет информацию о структуре процедуры в репозитории, в соответствии со структурой процедуры на сервере БД.
	CreateProcedure	Метод CreateProcedure осуществляет создание процедуры в базе данных на основе имеющихся метаданных.
	DropProcedure	Метод DropProcedure осуществляет удаление процедуры из базы данных на сервере.
	Refresh	Метод Refresh заканчивает обновление, сохраняя все изменения.
	UpdateProcedure	Метод UpdateProcedure осуществляет обновление структуры процедуры на сервере БД в соответствии со структурой текущей процедуры.

Методы, унаследованные от ISQLCommand

	Имя метода	Краткое описание
	ClearText	Метод ClearText осуществляет очистку оператора команды СУБД.

См. также:

Интерфейсы сборки Db | ISQLCommandInstance