sp_help (Transact-SQL)

Berlaku untuk: SQL Server (semua versi yang didukung) Azure SQL Database Azure SQL Managed Instance

Melaporkan informasi tentang objek database (objek apa pun yang tercantum dalam tampilan kompatibilitas sys.sysobjects ), jenis data yang ditentukan pengguna, atau jenis data.

Ikon tautan topikKonvensi Sintaks Transact-SQL

Sintaks

  
sp_help [ [ @objname = ] 'name' ]  

Argumen

[ @objname = ] 'name' Adalah nama objek apa pun, dalam sysobjects atau jenis data yang ditentukan pengguna dalam tabel systypes . nama adalah nvarchar(776), dengan default NULL. Nama database tidak dapat diterima. Dua atau tiga nama bagian dapat dibatasi, seperti 'Person.AddressType' atau '[Person]. [AddressType]'.

Mengembalikan Nilai Kode

0 (keberhasilan) atau 1 (kegagalan)

Tataan Hasil

Tataan hasil yang dikembalikan bergantung pada apakah nama ditentukan, kapan ditentukan, dan objek database mana.

  1. Jika sp_help dijalankan tanpa argumen, informasi ringkasan objek dari semua jenis yang ada dalam database saat ini dikembalikan.

    Nama kolom Jenis data Deskripsi
    Nama nvarchar(128) Nama Objek
    Pemilik nvarchar(128) Pemilik objek (Ini adalah prinsipal database yang memiliki objek . Default ke pemilik skema yang berisi objek.)
    Object_type nvarchar(31) Tipe objek
  2. Jika nama adalah jenis data SQL Server atau jenis data yang ditentukan pengguna, sp_help mengembalikan kumpulan hasil ini.

    Nama kolom Jenis data Deskripsi
    Type_name nvarchar(128) Nama jenis data.
    Storage_type nvarchar(128) SQL Server nama jenis.
    Panjang smallint Panjang fisik jenis data (dalam byte).
    Sebelumnya int Presisi (jumlah total digit).
    Skala int Jumlah digit di sebelah kanan desimal.
    Dapat diubah ke null varchar(35) Menunjukkan apakah nilai NULL diizinkan: Ya atau Tidak.
    Default_name nvarchar(128) Nama default yang terikat ke jenis ini.

    NULL = Tidak ada default yang terikat.
    Rule_name nvarchar(128) Nama aturan yang terikat ke jenis ini.

    NULL = Tidak ada default yang terikat.
    Kolase nama sysname Kolae jenis data. NULL untuk jenis data non-karakter.
  3. Jika nama adalah objek database selain jenis data, sp_help mengembalikan tataan hasil ini dan juga tataan hasil tambahan, berdasarkan jenis objek yang ditentukan.

    Nama kolom Jenis data Deskripsi
    Nama nvarchar(128) Nama tabel
    Pemilik nvarchar(128) pemilik tabel
    Jenis nvarchar(31) Jenis tabel
    Created_datetime datetime Tabel tanggal dibuat

    Bergantung pada objek database yang ditentukan, sp_help mengembalikan tataan hasil tambahan.

    Jika nama adalah tabel sistem, tabel pengguna, atau tampilan, sp_help mengembalikan tataan hasil berikut. Namun, tataan hasil yang menjelaskan di mana file data berada pada grup file tidak dikembalikan untuk tampilan.

    • Tataan hasil tambahan dikembalikan pada objek kolom:

      Nama kolom Jenis data Deskripsi
      Column_name nvarchar(128) Nama kolom.
      Jenis nvarchar(128) Jenis data kolom.
      Dihitung varchar(35) Menunjukkan apakah nilai dalam kolom dihitung: Ya atau Tidak.
      Panjang int Panjang kolom dalam byte.

      Catatan: Jika jenis data kolom adalah jenis nilai besar (varchar(max), nvarchar(max), varbinary(max), atau xml), nilai akan ditampilkan sebagai -1.
      Sebelumnya char(5) Presisi kolom.
      Skala char(5) Skala kolom.
      Dapat diubah ke null varchar(35) Menunjukkan apakah nilai NULL diizinkan di kolom: Ya atau Tidak.
      TrimTrailingBlanks varchar(35) Pangkas trailing kosong. Mengembalikan Ya atau Tidak.
      FixedLenNullInSource varchar(35) Hanya untuk kompatibilitas mundur.
      Kolase nama sysname Kolab kolom. NULL untuk jenis data noncharacter.
    • Tataan hasil tambahan dikembalikan pada kolom identitas:

      Nama kolom Jenis data Deskripsi
      Identitas nvarchar(128) Nama kolom yang tipe datanya dinyatakan sebagai identitas.
      Benih numerik Nilai awal untuk kolom identitas.
      Tahapan numerik Kenaikan untuk digunakan untuk nilai dalam kolom ini.
      Bukan Untuk Replikasi int Properti IDENTITY tidak diberlakukan saat login replikasi, seperti sqlrepl, menyisipkan data ke dalam tabel:

      1 = Benar

      0 = False
    • Tataan hasil tambahan dikembalikan pada kolom:

      Nama kolom Jenis data Deskripsi
      RowGuidCol nama sysname Nama kolom pengidentifikasi unik global.
    • Tataan hasil tambahan dikembalikan pada grup file:

      Nama kolom Jenis data Deskripsi
      Data_located_on_filegroup nvarchar(128) Grup file tempat data berada: Primer, Sekunder, atau Log Transaksi.
    • Tataan hasil tambahan dikembalikan pada indeks:

      Nama kolom Jenis data Deskripsi
      index_name nama sysname Nama indeks.
      Index_description varchar(210) Deskripsi indeks.
      index_keys nvarchar(2078) Nama kolom tempat indeks dibangun. Mengembalikan NULL untuk indeks penyimpan kolom yang dioptimalkan memori xVelocity.
    • Tataan hasil tambahan dikembalikan pada batasan:

      Nama kolom Jenis data Deskripsi
      constraint_type nvarchar(146) Jenis batasan.
      constraint_name nvarchar(128) Nama batasan.
      delete_action nvarchar(9) Menunjukkan apakah tindakan DELETE adalah: NO_ACTION, CASCADE, SET_NULL, SET_DEFAULT, atau N/A.

      Hanya berlaku untuk batasan KUNCI ASING.
      update_action nvarchar(9) Menunjukkan apakah tindakan UPDATE adalah: NO_ACTION, CASCADE, SET_NULL, SET_DEFAULT, atau N/A.

      Hanya berlaku untuk batasan KUNCI ASING.
      status_enabled varchar(8) Menunjukkan apakah batasan diaktifkan: Diaktifkan, Dinonaktifkan, atau N/A.

      Hanya berlaku untuk batasan CHECK dan FOREIGN KEY.
      status_for_replication varchar(19) Menunjukkan apakah batasan adalah untuk replikasi.

      Hanya berlaku untuk batasan CHECK dan FOREIGN KEY.
      constraint_keys nvarchar(2078) Nama kolom yang membentuk batasan atau, dalam kasus untuk default dan aturan, teks yang menentukan default atau aturan.
    • Tataan hasil tambahan dikembalikan pada objek referensi:

      Nama kolom Jenis data Deskripsi
      Tabel dirujuk oleh nvarchar(516) Mengidentifikasi objek database lain yang mereferensikan tabel.
    • Tataan hasil tambahan dikembalikan pada prosedur tersimpan, fungsi, atau prosedur tersimpan yang diperluas.

      Nama kolom Jenis data Deskripsi
      Parameter_name nvarchar(128) Nama parameter prosedur tersimpan.
      Jenis nvarchar(128) Jenis data parameter prosedur tersimpan.
      Panjang smallint Panjang penyimpanan fisik maksimum, dalam byte.
      Sebelumnya int Presisi atau jumlah total digit.
      Skala int Jumlah digit di sebelah kanan titik desimal.
      Param_order smallint Urutan parameter.

Keterangan

Prosedur sp_help hanya mencari objek dalam database saat ini.

Ketika nama tidak ditentukan, sp_help mencantumkan nama objek, pemilik, dan jenis objek untuk semua objek dalam database saat ini. sp_helptrigger menyediakan informasi tentang pemicu.

sp_help hanya mengekspos kolom indeks yang dapat diurutkan; oleh karena itu, ia tidak mengekspos informasi tentang indeks XML atau indeks spasial.

Izin

Memerlukan keanggotaan dalam peran publik . Pengguna harus memiliki setidaknya satu izin pada objname. Untuk melihat kunci batasan kolom, default, atau aturan, Anda harus memiliki izin LIHAT DEFINISI pada tabel.

Contoh

A. Mengembalikan informasi tentang semua objek

Contoh berikut mencantumkan informasi tentang setiap objek dalam master database.

USE master;  
GO  
EXEC sp_help;  
GO  

B. Mengembalikan informasi tentang satu objek

Contoh berikut menampilkan informasi tentang Person tabel.

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

Lihat juga

Prosedur Tersimpan Mesin Database (Transact-SQL)
sp_helpindex (T-SQL)
sp_helprotect (T-SQL)
sp_helpserver (Transact-SQL)
sp_helptrigger (T-SQL)
sp_helpuser (Transact-SQL)
Prosedur Tersimpan Sistem (Transact-SQL)
sys.sysobjects (Transact-SQL)