Bagikan melalui

sp_help (T-SQL)

  • Artikel

Berlaku untuk: SQL ServerAzure SQL Database Azure SQL Managed Instance

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

Konvensi sintaks transact-SQL

Sintaks

sp_help [ [ @objname = ] N'objname' ]
[ ; ]

Argumen

[ @objname = ] N'objname'

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

Mengembalikan nilai kode

0 (berhasil) atau 1 (kegagalan).

Tataan hasil

Kumpulan hasil yang dikembalikan bergantung pada apakah @name 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
    Name nvarchar(128) Nama Objek
    Owner nvarchar(128) Pemilik objek (Prinsipal database yang memiliki objek. Default ke pemilik skema yang berisi objek.)
    Object_type nvarchar(31) Tipe objek

  2. Jika @name adalah jenis data SQL Server atau jenis data yang ditentukan pengguna, sp_help mengembalikan tataan hasil ini.

    Nama kolom Jenis data Deskripsi
    Type_name nvarchar(128) Nama jenis data.
    Storage_type nvarchar(128) Nama jenis SQL Server.
    Length smallint Panjang fisik jenis data (dalam byte).
    Prec int Presisi (jumlah total digit).
    Scale int Jumlah digit di sebelah kanan desimal.
    Nullable varchar(35) Menunjukkan apakah NULL nilai diizinkan: Yes atau No.
    Default_name nvarchar(128) Nama default yang terikat ke tipe ini.

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

    NULL = Tidak ada default yang terikat.
    Collation nama sysname Kolatasi jenis data. NULL untuk jenis data non-karakter.

  3. Jika @name adalah objek database selain tipe data, sp_help mengembalikan tataan hasil ini dan juga tataan hasil tambahan, berdasarkan jenis objek yang ditentukan.

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

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

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

    • Kumpulan hasil berikut juga dikembalikan pada objek kolom:

      Nama kolom Jenis data Deskripsi
      Column_name nvarchar(128) Nama kolom.
      Type nvarchar(128) Jenis data kolom.
      Computed varchar(35) Menunjukkan apakah nilai dalam kolom dihitung: Yes atau No.
      Length int Panjang kolom dalam byte.

      Catatan: Jika jenis data kolom adalah jenis nilai besar (varchar(maks), nvarchar(max), varbinary(max), atau xml), nilai ditampilkan sebagai -1.
      Prec karakter(5) Presisi kolom.
      Scale karakter(5) Skala kolom.
      Nullable varchar(35) Menunjukkan apakah NULL nilai diizinkan dalam kolom: Yes atau No.
      TrimTrailingBlanks varchar(35) Pangkas trailing kosong. Mengembalikan Yes atau No.
      FixedLenNullInSource varchar(35) Parameter ini tidak digunakan lagi dan dipertahankan untuk kompatibilitas skrip mundur.
      Collation nama sysname Kolas kolom. NULL untuk jenis data noncharacter.

    • Kumpulan hasil berikut juga dikembalikan pada kolom identitas:

      Nama kolom Jenis data Deskripsi
      Identity nvarchar(128) Nama kolom yang tipe datanya dinyatakan sebagai identitas.
      Seed numerik Nilai awal untuk kolom identitas.
      Increment numerik Kenaikan yang akan digunakan untuk nilai dalam kolom ini.
      Not For Replication int IDENTITY properti tidak diberlakukan saat login replikasi, seperti sqlrepl, menyisipkan data ke dalam tabel:

      1 = Benar
      0 = False

    • Kumpulan hasil berikut juga dikembalikan pada kolom:

      Nama kolom Jenis data Deskripsi
      RowGuidCol nama sysname Nama kolom pengidentifikasi unik global.

    • Kumpulan hasil berikut juga dikembalikan pada grup file:

      Nama kolom Jenis data Deskripsi
      Data_located_on_filegroup nvarchar(128) Grup file tempat data berada: Primary, , Secondaryatau Transaction Log.

    • Kumpulan hasil berikut juga 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 memori yang dioptimalkan.

    • Kumpulan hasil berikut juga 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 DELETE tindakan adalah salah satu dari NO_ACTION, , CASCADESET_NULL, SET_DEFAULT, atau N/A.

      Hanya berlaku untuk batasan KUNCI ASING.
      update_action nvarchar(9) Menunjukkan apakah UPDATE tindakan adalah salah satu dari NO_ACTION, , CASCADESET_NULL, SET_DEFAULT, atau N/A.

      Hanya berlaku untuk FOREIGN KEY batasan.
      status_enabled varchar(8) Menunjukkan apakah batasan diaktifkan: Enabled, , Disabledatau N/A.

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

      Hanya berlaku untuk CHECK batasan 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.

    • Kumpulan hasil berikut juga dikembalikan pada objek referensi:

      Nama kolom Jenis data Deskripsi
      Table is referenced by nvarchar(516) Mengidentifikasi objek database lain yang mereferensikan tabel.

    • Tataan hasil berikut juga dikembalikan pada prosedur tersimpan, fungsi, atau prosedur tersimpan yang diperluas.

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

Keterangan

Prosedur sp_help hanya mencari objek dalam database saat ini.

Saat @name tidak ditentukan, sp_help daftar 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, ini 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 VIEW DEFINITION izin pada tabel.

Contoh

Sampel kode Transact-SQL dalam artikel ini menggunakan AdventureWorks2022 database sampel atau AdventureWorksDW2022 , yang dapat Anda unduh dari halaman beranda Sampel Microsoft SQL Server dan Proyek Komunitas.

J. 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.Person tabel.

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

Konten terkait