sp_help (Transact-SQL)sp_help (Transact-SQL)

ОБЛАСТЬ ПРИМЕНЕНИЯ: даSQL Server даБаза данных SQL Azure нетAzure Synapse Analytics (хранилище данных SQL) нетParallel Data WarehouseAPPLIES TO: yesSQL Server yesAzure SQL Database noAzure Synapse Analytics (SQL DW) noParallel Data Warehouse

Сообщает сведения об объекте базы данных (любом объекте, указанном в представлении совместимости sys. sysobjects ), определяемом пользователем типе данных или типе данных.Reports information about a database object (any object listed in the sys.sysobjects compatibility view), a user-defined data type, or a data type.

Значок ссылки на раздел Синтаксические обозначения в Transact-SQLTopic link icon Transact-SQL Syntax Conventions

СинтаксисSyntax

  
sp_help [ [ @objname = ] 'name' ]  

АргументыArguments

[ @objname = ] 'name' — это имя любого объекта, в sysobjects или любого определяемого пользователем типа данных в таблице systypes .[ @objname = ] 'name' Is the name of any object, in sysobjects or any user-defined data type in the systypes table. Name имеет тип nvarchar ( 776 ) и значение по умолчанию NULL.name is nvarchar( 776 ), with a default of NULL. Имена баз данных неприемлемы.Database names are not acceptable. Имена из двух или трех частей должны содержать разделители, например "<Человек>.<Тип_адреса>" или [<Человек>.<Тип_адреса>].Two or three part names must be delimited, such as 'Person.AddressType' or [Person.AddressType].

Значения кода возвратаReturn Code Values

0 (успешное завершение) или 1 (неуспешное завершение)0 (success) or 1 (failure)

Результирующие наборыResult Sets

Возвращаемые результирующие наборы зависят от того, указано ли имя , когда оно указано и какой объект базы данных он имеет.The result sets that are returned depend on whether name is specified, when it is specified, and which database object it is.

  1. Если sp_help выполняется без аргументов, возвращаются сводные сведения об объектах всех типов, существующих в текущей базе данных.If sp_help is executed with no arguments, summary information of objects of all types that exist in the current database is returned.

    Имя столбцаColumn name Тип данныхData type ОписаниеDescription
    ИмяName nvarchar ( 128 )nvarchar( 128 ) Имя объектаObject name
    ВладелецOwner nvarchar ( 128 )nvarchar( 128 ) Владелец объекта (участник базы данных, владеющий объектом,Object owner (This is the database principal that owns object. по умолчанию совпадает с владельцем схемы, содержащей объект).Defaults to the owner of the schema that contains the object.)
    Object_typeObject_type nvarchar ( 31 )nvarchar( 31 ) Тип объектаObject type
  2. Если Name является SQL ServerSQL Server типом данных или определяемым пользователем типом данных, sp_help возвращает этот результирующий набор.If name is a SQL ServerSQL Server data type or user-defined data type, sp_help returns this result set.

    Имя столбцаColumn name Тип данныхData type ОписаниеDescription
    Type_nameType_name nvarchar ( 128 )nvarchar( 128 ) Имя типа данных.Data type name.
    Storage_typeStorage_type nvarchar ( 128 )nvarchar( 128 ) Имя типа данных SQL ServerSQL Server.SQL ServerSQL Server type name.
    ДлинаLength smallintsmallint Физическая длина типа данных (в байтах).Physical length of the data type (in bytes).
    прекPrec intint Точность (общее количество знаков).Precision (total number of digits).
    МасштабScale intint Количество знаков справа от десятичной запятой.Number of digits to the right of the decimal.
    Допускает значения NULLNullable varchar ( 35 )varchar( 35 ) Указывает, разрешены ли значения NULL: Да или нет.Indicates whether NULL values are allowed: Yes or No.
    Default_nameDefault_name nvarchar ( 128 )nvarchar( 128 ) Имя значения по умолчанию, привязанного к этому типу.Name of a default bound to this type.

    NULL = нет привязанного правила по умолчанию.NULL = No default is bound.
    Rule_nameRule_name nvarchar ( 128 )nvarchar( 128 ) Имя правила, привязанного к этому типу.Name of a rule bound to this type.

    NULL = нет привязанного правила по умолчанию.NULL = No default is bound.
    Параметры сортировкиCollation sysnamesysname Параметры сортировки для типа данных.Collation of the data type. Имеет значение NULL для несимвольных типов данных.NULL for non-character data types.
  3. Если Name — любой объект базы данных, кроме типа данных, sp_help возвращает этот результирующий набор, а также дополнительные результирующие наборы на основе указанного типа объекта.If name is any database object other than a data type, sp_help returns this result set and also additional result sets, based on the type of object specified.

    Имя столбцаColumn name Тип данныхData type ОписаниеDescription
    ИмяName nvarchar ( 128 )nvarchar( 128 ) Имя таблицыTable name
    ВладелецOwner nvarchar ( 128 )nvarchar( 128 ) Владелец таблицыTable owner
    ТипType nvarchar ( 31 )nvarchar( 31 ) Тип таблицыTable type
    Created_datetimeCreated_datetime datetimedatetime Дата создания таблицыDate table created

    В зависимости от указанного объекта базы данных sp_help Возвращает дополнительные результирующие наборы.Depending on the database object specified, sp_help returns additional result sets.

    Если имя является системной таблицей, пользовательской таблицей или представлением, sp_help возвращает следующие результирующие наборы.If name is a system table, user table, or view, sp_help returns the following result sets. Однако результирующий набор, описывающий место расположения файла данных внутри файловой группы, для представления не возвращается.However, the result set that describes where the data file is located on a file group is not returned for a view.

    • Дополнительный результирующий набор, возвращаемый для объектов столбца:Additional result set returned on column objects:

      Имя столбцаColumn name Тип данныхData type ОписаниеDescription
      Column_nameColumn_name nvarchar ( 128 )nvarchar( 128 ) Имя столбца.Column name.
      ТипType nvarchar ( 128 )nvarchar( 128 ) Тип данных столбца.Column data type.
      ВычисляемыйComputed varchar ( 35 )varchar( 35 ) Указывает, вычисляются ли значения в столбце: Да или нет.Indicates whether the values in the column are computed: Yes or No.
      ДлинаLength intint Длина столбца в байтах.Column length in bytes.

      Примечание. Если тип данных столбца имеет тип больших значений (varchar (max) , nvarchar (max) , varbinary (max) или XML), то значение будет отображаться как-1.Note: If the column data type is a large value type (varchar(max), nvarchar(max), varbinary(max), or xml), the value will display as -1.
      прекPrec char ( 5 )char( 5 ) Точность столбца.Column precision.
      МасштабScale char ( 5 )char( 5 ) Масштаб столбца.Column scale.
      Допускает значения NULLNullable varchar ( 35 )varchar( 35 ) Указывает, разрешены ли значения NULL в столбце: Да или нет.Indicates whether NULL values are allowed in the column: Yes or No.
      тримтраилингбланксTrimTrailingBlanks varchar ( 35 )varchar( 35 ) Указывает, усекать ли завершающие пробелы или нет.Trim the trailing blanks. Возвращает значение Yes или No.Returns Yes or No.
      фикседленнуллинсаурцеFixedLenNullInSource varchar ( 35 )varchar( 35 ) Только для обратной совместимости.For backward compatibility only.
      Параметры сортировкиCollation sysnamesysname Параметры сортировки столбца.Collation of the column. Имеет значение NULL для несимвольных типов данных.NULL for noncharacter data types.
    • Дополнительный результирующий набор, возвращаемый для столбцов идентификаторов:Additional result set returned on identity columns:

      Имя столбцаColumn name Тип данныхData type ОписаниеDescription
      ИдентификаторIdentity nvarchar ( 128 )nvarchar( 128 ) Имя столбца, чей тип данных объявлен удостоверением.Column name whose data type is declared as identity.
      ИнициализироватьSeed numericnumeric Стартовое значение для столбца идентификаторов.Starting value for the identity column.
      ПриращениеIncrement numericnumeric Шаг прироста, который следует использовать для значений в этом столбце.Increment to use for values in this column.
      Не для репликацииNot For Replication intint Свойство IDENTITY не применяется принудительно, если имя входа репликации, например склрепл, вставляет данные в таблицу:IDENTITY property is not enforced when a replication login, such as sqlrepl, inserts data into the table:

      1 = True1 = True

      0 = False.0 = False
    • Дополнительный результирующий набор, возвращаемый для столбцов:Additional result set returned on columns:

      Имя столбцаColumn name Тип данныхData type ОписаниеDescription
      RowGuidColRowGuidCol sysnamesysname Имя столбца глобального уникального идентификатора.Name of the global unique identifier column.
    • Дополнительный результирующий набор, возвращаемый для файловых групп:Additional result set returned on filegroups:

      Имя столбцаColumn name Тип данныхData type ОписаниеDescription
      Data_located_on_filegroupData_located_on_filegroup nvarchar ( 128 )nvarchar( 128 ) Файловая группа, в которой находятся данные: первичный, вторичный или журнал транзакций.Filegroup in which the data is located: Primary, Secondary, or Transaction Log.
    • Дополнительный результирующий набор, возвращаемый для индексов:Additional result set returned on indexes:

      Имя столбцаColumn name Тип данныхData type ОписаниеDescription
      index_nameindex_name sysnamesysname Имя индекса.Index name.
      Index_descriptionIndex_description varchar ( 210 )varchar( 210 ) Описание индекса.Description of the index.
      index_keysindex_keys nvarchar ( 2078 )nvarchar( 2078 ) Имена столбцов, на основе которых построен индекс.Column names on which the index is built. Возвращает значение NULL для оптимизированных для памяти xVelocity индексов columnstore.Returns NULL for xVelocity memory optimized columnstore indexes.
    • Дополнительный результирующий набор, возвращаемый для ограничений:Additional result set returned on constraints:

      Имя столбцаColumn name Тип данныхData type ОписаниеDescription
      constraint_typeconstraint_type nvarchar ( 146 )nvarchar( 146 ) Тип ограничения.Type of constraint.
      constraint_nameconstraint_name nvarchar ( 128 )nvarchar( 128 ) Имя ограничения.Name of the constraint.
      delete_actiondelete_action nvarchar ( 9 )nvarchar( 9 ) Указывает, имеет ли действие DELETE: NO_ACTION, CASCADE, SET_NULL, SET_DEFAULT или N/A.Indicates whether the DELETE action is: NO_ACTION, CASCADE, SET_NULL, SET_DEFAULT, or N/A.

      Применимо только для ограничений FOREIGN KEY.Only applicable to FOREIGN KEY constraints.
      update_actionupdate_action nvarchar ( 9 )nvarchar( 9 ) Указывает, имеет ли действие UPDATE: NO_ACTION, CASCADE, SET_NULL, SET_DEFAULT или N/A.Indicates whether the UPDATE action is: NO_ACTION, CASCADE, SET_NULL, SET_DEFAULT, or N/A.

      Применимо только для ограничений FOREIGN KEY.Only applicable to FOREIGN KEY constraints.
      status_enabledstatus_enabled varchar ( 8 )varchar( 8 ) Указывает, включено ли ограничение: включено, отключено или н/д.Indicates whether the constraint is enabled: Enabled, Disabled, or N/A.

      Применимо только для ограничений CHECK и FOREIGN KEY.Only applicable to CHECK and FOREIGN KEY constraints.
      status_for_replicationstatus_for_replication varchar ( 19 )varchar( 19 ) Указывает, предназначено ли ограничение для репликации.Indicates whether the constraint is for replication.

      Применимо только для ограничений CHECK и FOREIGN KEY.Only applicable to CHECK and FOREIGN KEY constraints.
      constraint_keysconstraint_keys nvarchar ( 2078 )nvarchar( 2078 ) Имена столбцов, составляющих ограничение, или, в случае со значениями по умолчанию и правилами, текст, определяющий значение по умолчанию или правило.Names of the columns that make up the constraint or, in the case for defaults and rules, the text that defines the default or rule.
    • Дополнительный результирующий набор, возвращаемый для ссылочных объектов:Additional result set returned on referencing objects:

      Имя столбцаColumn name Тип данныхData type ОписаниеDescription
      На таблицу ссылаетсяTable is referenced by nvarchar ( 516 )nvarchar( 516 ) Указывает другие объекты базы данных, которые ссылаются на таблицу.Identifies other database objects that reference the table.
    • Дополнительный результирующий набор, возвращаемый для хранимых процедур, функций или расширенных хранимых процедур.Additional result set returned on stored procedures, functions, or extended stored procedures.

      Имя столбцаColumn name Тип данныхData type ОписаниеDescription
      Parameter_nameParameter_name nvarchar ( 128 )nvarchar( 128 ) Имя аргумента хранимой процедуры.Stored procedure parameter name.
      ТипType nvarchar ( 128 )nvarchar( 128 ) Тип данных аргумента хранимой процедуры.Data type of the stored procedure parameter.
      ДлинаLength smallintsmallint Максимальная физическая длина хранилища, в байтах.Maximum physical storage length, in bytes.
      прекPrec intint Точность или общее количество знаков.Precision or total number of digits.
      МасштабScale intint Число цифр справа от десятичной запятой.Number of digits to the right of the decimal point.
      Param_orderParam_order smallintsmallint Порядок аргумента.Order of the parameter.

RemarksRemarks

Процедура sp_help выполняет поиск объекта только в текущей базе данных.The sp_help procedure looks for an object in the current database only.

Если параметр Name не указан, sp_help перечисляет имена объектов, владельцев и типы объектов для всех объектов в текущей базе данных.When name is not specified, sp_help lists object names, owners, and object types for all objects in the current database. sp_helptrigger предоставляет сведения о триггерах.sp_helptrigger provides information about triggers.

sp_help предоставляет только столбцы индексов, упорядоченные по столбцам; Поэтому он не предоставляет сведения о XML-индексах и пространственных индексах.sp_help exposes only orderable index columns; therefore, it does not expose information about XML indexes or spatial indexes.

РазрешенияPermissions

Необходимо быть членом роли public .Requires membership in the public role. Пользователь должен иметь по крайней мере одно разрешение на объект objname.The user must have at least one permission on objname. Чтобы просмотреть ключи, значения по умолчанию или правила ограничения для столбца, необходимо обладать разрешением VIEW DEFINITION для этой таблицы.To view column constraint keys, defaults, or rules, you must have VIEW DEFINITION permission on the table.

ПримерыExamples

A.A. Возвращение сведений обо всех объектахReturning information about all objects

В нижеследующем примере приводится информация о каждом объекте в базе данных master.The following example lists information about each object in the master database.

USE master;  
GO  
EXEC sp_help;  
GO  

б.B. Возвращение сведений об отдельном объектеReturning information about a single object

В нижеследующем примере отображаются сведения о таблице Person.The following example displays information about the Person table.

USE AdventureWorks2012;  
GO  
EXEC sp_help 'Person.Person';  
GO  

См. также статьюSee Also

Transact- (SQL) ядро СУБД хранимых процедурDatabase Engine Stored Procedures (Transact-SQL)
sp_helpindex ( Transact-) SQLsp_helpindex (Transact-SQL)
sp_helprotect (Transact-SQL) sp_helprotect (Transact-SQL)
sp_helpserver (Transact-SQL) sp_helpserver (Transact-SQL)
sp_helptrigger (Transact-SQL) sp_helptrigger (Transact-SQL)
sp_helpuser ( Transact-) SQLsp_helpuser (Transact-SQL)
Системные хранимые процедуры (Transact-SQL) System Stored Procedures (Transact-SQL)
sys. sysobjects (TRANSACT-SQL)sys.sysobjects (Transact-SQL)