sp_help (Transact-SQL)
Применяется к:
SQL ServerAzure SQL DatabaseAzure, управляемому экземпляру SQL Azure
Сообщает сведения об объекте базы данных (любом объекте , указанном в представлении совместимости sys.sysobjects ), определяемом пользователем типе данных или типе данных.
Соглашения о синтаксисе Transact-SQL
Синтаксис
sp_help [ [ @objname = ] 'name' ]
Аргументы
[ @objname = ] 'name' Имя любого объекта в sysobjects или любой определяемый пользователем тип данных в таблице systypes . имя nvarchar (776) с значением NULL по умолчанию. Имена баз данных неприемлемы. Два или три названия частей могут быть разделены, например Person.AddressType или [Person]. [AddressType]'.
Значения кода возврата
0 (успешное завершение) или 1 (неуспешное завершение)
Результирующие наборы
Результирующие наборы, возвращаемые, зависят от того, задано ли имя , когда он указан, и какой объект базы данных он имеет.
Если sp_help выполняется без аргументов, возвращается сводная информация об объектах всех типов, существующих в текущей базе данных.
Имя столбца Тип данных Описание: Полное имя nvarchar(128) Наименование объекта Ответственное лицо nvarchar(128) Владелец объекта (это субъект базы данных, которому принадлежит объект. По умолчанию владелец схемы, содержащей объект.) Object_type nvarchar(31) Тип объекта Если имя — это тип данных SQL Server или определяемый пользователем тип данных, sp_help возвращает этот результирующий набор.
Имя столбца Тип данных Описание: Type_name nvarchar(128) Имя типа данных. Storage_type nvarchar(128) Имя типа SQL Server. Длина smallint Физическая длина типа данных (в байтах). Prec int Точность (общее количество знаков). Масштаб int Количество знаков справа от десятичной запятой. Допускает значения NULL varchar(35) Указывает, разрешены ли значения NULL: Да или Нет. Default_name nvarchar(128) Имя значения по умолчанию, привязанного к этому типу.
NULL = нет привязанного правила по умолчанию.Rule_name nvarchar(128) Имя правила, привязанного к этому типу.
NULL = нет привязанного правила по умолчанию.Параметры сортировки sysname Параметры сортировки для типа данных. Имеет значение NULL для несимвольных типов данных. Если имя является любым объектом базы данных, отличным от типа данных, sp_help возвращает этот результирующий набор, а также дополнительные результирующие наборы на основе указанного типа объекта.
Имя столбца Тип данных Описание: Полное имя nvarchar(128) Имя таблицы Ответственное лицо nvarchar(128) Владелец таблицы Тип nvarchar(31) Тип таблицы Created_datetime datetime Дата создания таблицы В зависимости от указанного объекта базы данных sp_help возвращает дополнительные результирующие наборы.
Если имя является системной таблицей, пользовательской таблицей или представлением, sp_help возвращает следующие результирующие наборы. Однако результирующий набор, описывающий место расположения файла данных внутри файловой группы, для представления не возвращается.
Дополнительный результирующий набор, возвращаемый для объектов столбца:
Имя столбца Тип данных Описание: Column_name nvarchar(128) Имя столбца. Тип nvarchar(128) Тип данных столбца. Вычисляемый varchar(35) Указывает, вычисляются ли значения в столбце: да или нет. Длина int Длина столбца в байтах.
Примечание. Если тип данных столбца является большим типом значения (varchar(max),nvarchar(max), varbinary(max)или xml), значение будет отображаться как -1.Prec char(5) Точность столбца. Масштаб char(5) Масштаб столбца. Допускает значения NULL varchar(35) Указывает, разрешены ли значения NULL в столбце: да или нет. TrimTrailingBlanks varchar(35) Указывает, усекать ли завершающие пробелы или нет. Возвращает значение Yes или No. FixedLenNullInSource varchar(35) Только для обратной совместимости. Параметры сортировки sysname Параметры сортировки столбца. Имеет значение NULL для несимвольных типов данных. Дополнительный результирующий набор, возвращаемый для столбцов идентификаторов:
Имя столбца Тип данных Описание: Identity nvarchar(128) Имя столбца, чей тип данных объявлен удостоверением. Seed numeric Стартовое значение для столбца идентификаторов. Приращение numeric Шаг прироста, который следует использовать для значений в этом столбце. Не для репликации int Свойство IDENTITY не применяется при входе репликации, например sqlrepl, вставляет данные в таблицу:
1 = True
0 = False.Дополнительный результирующий набор, возвращаемый для столбцов:
Имя столбца Тип данных Описание: RowGuidCol sysname Имя столбца глобального уникального идентификатора. Дополнительный результирующий набор, возвращаемый для файловых групп:
Имя столбца Тип данных Описание: Data_located_on_filegroup nvarchar(128) Файловая группа, в которой находятся данные: основной, вторичный или журнал транзакций. Дополнительный результирующий набор, возвращаемый для индексов:
Имя столбца Тип данных Описание: index_name sysname Имя индекса. Index_description varchar(210) Описание индекса. index_keys nvarchar(2078) Имена столбцов, на основе которых построен индекс. Возвращает значение NULL для оптимизированных для памяти xVelocity индексов columnstore. Дополнительный результирующий набор, возвращаемый для ограничений:
Имя столбца Тип данных Описание: constraint_type nvarchar(146) Тип ограничения. constraint_name nvarchar(128) Имя ограничения. delete_action nvarchar(9) Указывает, является ли действие DELETE: NO_ACTION, CASCADE, SET_NULL, SET_DEFAULT или N/A.
Применимо только для ограничений FOREIGN KEY.update_action nvarchar(9) Указывает, является ли действие UPDATE: NO_ACTION, CASCADE, SET_NULL, SET_DEFAULT или N/A.
Применимо только для ограничений FOREIGN KEY.status_enabled varchar(8) Указывает, включено ли ограничение: включено, отключено или N/A.
Применимо только для ограничений CHECK и FOREIGN KEY.status_for_replication varchar(19) Указывает, предназначено ли ограничение для репликации.
Применимо только для ограничений CHECK и FOREIGN KEY.constraint_keys nvarchar(2078) Имена столбцов, составляющих ограничение, или, в случае со значениями по умолчанию и правилами, текст, определяющий значение по умолчанию или правило. Дополнительный результирующий набор, возвращаемый для ссылочных объектов:
Имя столбца Тип данных Описание: Таблица ссылается на nvarchar(516) Указывает другие объекты базы данных, которые ссылаются на таблицу. Дополнительный результирующий набор, возвращаемый для хранимых процедур, функций или расширенных хранимых процедур.
Имя столбца Тип данных Описание: Parameter_name nvarchar(128) Имя аргумента хранимой процедуры. Тип nvarchar(128) Тип данных аргумента хранимой процедуры. Длина smallint Максимальная физическая длина хранилища, в байтах. Prec int Точность или общее количество знаков. Масштаб int Число цифр справа от десятичной запятой. Param_order smallint Порядок аргумента.
Замечания
Процедура sp_help ищет объект только в текущей базе данных.
Если имя не указано, sp_help перечисляет имена объектов, владельцев и типы объектов для всех объектов в текущей базе данных. sp_helptrigger предоставляет сведения о триггерах.
sp_help предоставляет только упорядоченные столбцы индекса; поэтому он не предоставляет сведения о XML-индексах или пространственных индексах.
Разрешения
Необходимо быть членом роли public. Пользователь должен иметь по крайней мере одно разрешение на objname. Чтобы просмотреть ключи, значения по умолчанию или правила ограничения для столбца, необходимо обладать разрешением VIEW DEFINITION для этой таблицы.
Примеры
О. Возвращение сведений обо всех объектах
В нижеследующем примере приводится информация о каждом объекте в базе данных master.
USE master;
GO
EXEC sp_help;
GO
B. Возвращение сведений об отдельном объекте
В нижеследующем примере отображаются сведения о таблице Person.
USE AdventureWorks2022;
GO
EXEC sp_help 'Person.Person';
GO
См. также
Хранимые процедуры ядра СУБД (Transact-SQL)
sp_helpindex (Transact-SQL)
sp_helprotect (Transact-SQL)
sp_helpserver (Transact-SQL)
sp_helptrigger (Transact-SQL)
sp_helpuser (Transact-SQL)
Системные хранимые процедуры (Transact-SQL)
sys.sysobjects (Transact-SQL)
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по