Referensi fungsi untuk Ekstensi Bahasa Tepercaya untuk Postgre SQL - Amazon Aurora

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Referensi fungsi untuk Ekstensi Bahasa Tepercaya untuk Postgre SQL

Lihat dokumentasi referensi berikut tentang fungsi yang tersedia di Ekstensi Bahasa Tepercaya untuk PostgreSQL. Gunakan fungsi-fungsi ini untuk menginstal, mendaftar, memperbarui, dan mengelola TLEekstensi Anda, yaitu SQL ekstensi Postgre yang Anda kembangkan menggunakan kit pengembangan Ekstensi Bahasa Tepercaya.

pgtle.available_extensions

Fungsi pgtle.available_extensions adalah fungsi pengembalian set. Ia mengembalikan semua TLE ekstensi yang tersedia dalam database. Setiap baris yang dikembalikan berisi informasi tentang TLE ekstensi tunggal.

Prototipe fungsi

pgtle.available_extensions()

Peran

Tidak ada.

Argumen

Tidak ada.

Output

  • name— Nama TLE ekstensi.

  • default_version— Versi TLE ekstensi yang akan digunakan saat CREATE EXTENSION dipanggil tanpa versi yang ditentukan.

  • description— Penjelasan yang lebih rinci tentang TLE ekstensi.

Contoh penggunaan

SELECT * FROM pgtle.available_extensions();

pgtle.available_extension_versions

Fungsi available_extension_versions adalah fungsi pengembalian set. Ini mengembalikan daftar semua TLE ekstensi yang tersedia dan versinya. Setiap baris berisi informasi tentang versi tertentu dari TLE ekstensi yang diberikan, termasuk apakah itu memerlukan peran tertentu.

Prototipe fungsi

pgtle.available_extension_versions()

Peran

Tidak ada.

Argumen

Tidak ada.

Output

  • name— Nama TLE ekstensi.

  • version— Versi TLE ekstensi.

  • superuser— Nilai ini selalu false untuk TLE ekstensi Anda. Izin yang diperlukan untuk membuat TLE ekstensi atau memperbaruinya sama dengan membuat objek lain dalam database yang diberikan.

  • trusted— Nilai ini selalu false untuk TLE ekstensi.

  • relocatable— Nilai ini selalu false untuk TLE ekstensi.

  • schema— Menentukan nama skema di mana TLE ekstensi diinstal.

  • requires— Array yang berisi nama-nama ekstensi lain yang dibutuhkan oleh TLE ekstensi ini.

  • description— Penjelasan rinci tentang TLE ekstensi.

Untuk informasi selengkapnya tentang nilai keluaran, lihat Mengemas Objek Terkait ke dalam Ekstensi > File Ekstensi dalam dokumentasi PostgreSQL.

Contoh penggunaan

SELECT * FROM pgtle.available_extension_versions();

pgtle.extension_update_paths

Fungsi extension_update_paths adalah fungsi pengembalian set. Ini mengembalikan daftar semua jalur pembaruan yang mungkin untuk TLE ekstensi. Setiap baris menyertakan peningkatan atau penurunan versi yang tersedia untuk ekstensi itu. TLE

Prototipe fungsi

pgtle.extension_update_paths(name)

Peran

Tidak ada.

Argumen

name— Nama TLE ekstensi dari mana untuk mendapatkan jalur upgrade.

Output

  • source – Versi sumber untuk pembaruan.

  • target – Versi target untuk pembaruan.

  • path— Jalur pemutakhiran yang digunakan untuk memperbarui TLE ekstensi dari source target versi ke versi, misalnya,0.1--0.2.

Contoh penggunaan

SELECT * FROM pgtle.extension_update_paths('your-TLE');

pgtle.install_extension

install_extensionFungsi ini memungkinkan Anda menginstal artefak yang membentuk TLE ekstensi Anda di database, setelah itu dapat dibuat menggunakan CREATE EXTENSION perintah.

Prototipe fungsi

pgtle.install_extension(name text, version text, description text, ext text, requires text[] DEFAULT NULL::text[])

Peran

Tidak ada.

Argumen

  • name— Nama TLE ekstensi. Nilai ini digunakan saat memanggil CREATE EXTENSION.

  • version— Versi TLE ekstensi.

  • description— Penjelasan rinci tentang TLE ekstensi. Deskripsi ini ditampilkan di kolom comment pada pgtle.available_extensions().

  • ext— Isi TLE ekstensi. Nilai ini berisi objek seperti fungsi.

  • requires— Parameter opsional yang menentukan dependensi untuk ekstensi ini. TLE Ekstensi pg_tle secara otomatis ditambahkan sebagai dependensi.

Banyak dari argumen ini sama dengan yang disertakan dalam file kontrol ekstensi untuk menginstal ekstensi Postgre SQL pada sistem file instance SQL Postgre. Untuk informasi selengkapnya, lihat File Ekstensi dalam Kemasan Objek Terkait ke Ekstensi dalam dokumentasi PostgreSQL.

Output

Fungsi ini akan mengembalikan OK jika berhasil, dan NULL jika terjadi kesalahan.

  • OK— TLE Ekstensi telah berhasil dipasang di database.

  • NULL— TLE Ekstensi belum berhasil dipasang di database.

Contoh penggunaan

SELECT pgtle.install_extension( 'pg_tle_test', '0.1', 'My first pg_tle extension', $_pgtle_$ CREATE FUNCTION my_test() RETURNS INT AS $$ SELECT 42; $$ LANGUAGE SQL IMMUTABLE; $_pgtle_$ );

pgtle.install_update_path

install_update_pathFungsi ini menyediakan jalur pembaruan antara dua versi TLE ekstensi yang berbeda. Fungsi ini memungkinkan pengguna TLE ekstensi Anda untuk memperbarui versinya dengan menggunakan ALTER EXTENSION ... UPDATE sintaks.

Prototipe fungsi

pgtle.install_update_path(name text, fromvers text, tovers text, ext text)

Peran

pgtle_admin

Argumen

  • name— Nama TLE ekstensi. Nilai ini digunakan saat memanggil CREATE EXTENSION.

  • fromvers— Versi sumber TLE ekstensi untuk peningkatan.

  • tovers— Versi tujuan TLE ekstensi untuk peningkatan.

  • ext – Konten pembaruan. Nilai ini berisi objek seperti fungsi.

Output

Tidak ada.

Contoh penggunaan

SELECT pgtle.install_update_path('pg_tle_test', '0.1', '0.2', $_pgtle_$ CREATE OR REPLACE FUNCTION my_test() RETURNS INT AS $$ SELECT 21; $$ LANGUAGE SQL IMMUTABLE; $_pgtle_$ );

pgtle.register_feature

register_featureFungsi menambahkan SQL fitur Postgre internal yang ditentukan ke tabel. pgtle.feature_info Postgre SQL hook adalah contoh fitur Postgre internal. SQL Kit pengembangan Ekstensi Bahasa Tepercaya mendukung penggunaan kait PostgreSQL. Saat ini, fungsi ini mendukung fitur berikut.

  • passcheck— Mendaftarkan hook pemeriksaan kata sandi dengan prosedur atau fungsi Anda yang menyesuaikan perilaku pemeriksaan kata sandi Postgre. SQL

Prototipe fungsi

pgtle.register_feature(proc regproc, feature pg_tle_feature)

Peran

pgtle_admin

Argumen

  • proc – Nama prosedur atau fungsi yang disimpan untuk digunakan dengan fitur tersebut.

  • feature – Nama fitur pg_tle (seperti passcheck) untuk mendaftar dengan fungsi.

Output

Tidak ada.

Contoh penggunaan

SELECT pgtle.register_feature('pw_hook', 'passcheck');

pgtle.register_feature_if_not_exists

pgtle.register_feature_if_not_existsFungsi menambahkan SQL fitur Postgre yang ditentukan ke pgtle.feature_info tabel dan mengidentifikasi TLE ekstensi atau prosedur atau fungsi lain yang menggunakan fitur tersebut. Untuk informasi selengkapnya tentang hook dan Trusted Language Extensions, lihat Menggunakan SQL kait Postgre dengan ekstensi Anda TLE.

Prototipe fungsi

pgtle.register_feature_if_not_exists(proc regproc, feature pg_tle_feature)

Peran

pgtle_admin

Argumen

  • proc— Nama prosedur atau fungsi tersimpan yang berisi logika (kode) untuk digunakan sebagai fitur untuk TLE ekstensi Anda. Misalnya, kode pw_hook.

  • feature— Nama SQL fitur Postgre untuk mendaftar untuk fungsi tersebut. TLE Saat ini, satu-satunya fitur yang tersedia adalah hook passcheck. Untuk informasi selengkapnya, lihat Hook pemeriksaan kata sandi (passcheck).

Output

Mengembalikan true setelah mendaftarkan fitur untuk ekstensi yang ditentukan. Mengembalikan false jika fitur sudah terdaftar.

Contoh penggunaan

SELECT pgtle.register_feature_if_not_exists('pw_hook', 'passcheck');

pgtle.set_default_version

set_default_versionFungsi ini memungkinkan Anda menentukan default_version untuk TLE ekstensi Anda. Anda dapat menggunakan fungsi ini untuk menentukan jalur pemutakhiran dan menetapkan versi sebagai default untuk TLE ekstensi Anda. Ketika pengguna database menentukan TLE ekstensi Anda dalam ALTER EXTENSION ... UPDATE perintah CREATE EXTENSION dan, versi TLE ekstensi Anda dibuat dalam database untuk pengguna tersebut.

Fungsi ini mengembalikan true jika berhasil. Jika TLE ekstensi yang ditentukan dalam name argumen tidak ada, fungsi mengembalikan kesalahan. Demikian pula, jika TLE ekstensi tidak ada, ia mengembalikan kesalahan. version

Prototipe fungsi

pgtle.set_default_version(name text, version text)

Peran

pgtle_admin

Argumen

  • name— Nama TLE ekstensi. Nilai ini digunakan saat memanggil CREATE EXTENSION.

  • version— Versi TLE ekstensi untuk mengatur default.

Output

  • true – Saat pengaturan versi default berhasil, fungsi mengembalikan true.

  • ERROR— Mengembalikan pesan kesalahan jika TLE ekstensi dengan nama atau versi tertentu tidak ada.

Contoh penggunaan

SELECT * FROM pgtle.set_default_version('my-extension', '1.1');

pgtle.uninstall_extension(nama)

uninstall_extensionFungsi ini menghapus semua versi TLE ekstensi dari database. Fungsi ini mencegah panggilan future CREATE EXTENSION dari menginstal TLE ekstensi. Jika TLE ekstensi tidak ada dalam database, kesalahan muncul.

uninstall_extensionFungsi tidak akan menjatuhkan TLE ekstensi yang saat ini aktif dalam database. Untuk menghapus TLE ekstensi yang saat ini aktif, Anda perlu memanggil secara eksplisit DROP EXTENSION untuk menghapusnya.

Prototipe fungsi

pgtle.uninstall_extension(extname text)

Peran

pgtle_admin

Argumen

  • extname— Nama TLE ekstensi yang akan dihapus. Nama ini sama dengan yang digunakan CREATE EXTENSION untuk memuat TLE ekstensi untuk digunakan dalam database tertentu.

Output

Tidak ada.

Contoh penggunaan

SELECT * FROM pgtle.uninstall_extension('pg_tle_test');

pgtle.uninstall_extension (nama, versi)

uninstall_extension(name, version)Fungsi ini menghapus versi TLE ekstensi yang ditentukan dari database. Fungsi ini mencegah CREATE EXTENSION dan ALTER EXTENSION dari menginstal atau memperbarui TLE ekstensi ke versi yang ditentukan. Fungsi ini juga menghapus semua jalur pembaruan untuk versi TLE ekstensi yang ditentukan. Fungsi ini tidak akan menghapus instalasi TLE ekstensi jika saat ini aktif dalam database. Anda harus secara eksplisit memanggil DROP EXTENSION untuk menghapus ekstensi. TLE Untuk menghapus semua versi TLE ekstensi, lihatpgtle.uninstall_extension(nama).

Prototipe fungsi

pgtle.uninstall_extension(extname text, version text)

Peran

pgtle_admin

Argumen

  • extname— Nama TLE ekstensi. Nilai ini digunakan saat memanggil CREATE EXTENSION.

  • version— Versi TLE ekstensi untuk menghapus instalasi dari database.

Output

Tidak ada.

Contoh penggunaan

SELECT * FROM pgtle.uninstall_extension('pg_tle_test', '0.2');

pgtle.uninstall_extension_if_exists

uninstall_extension_if_existsFungsi ini menghapus semua versi TLE ekstensi dari database yang diberikan. Jika TLE ekstensi tidak ada, fungsi kembali diam-diam (tidak ada pesan kesalahan yang muncul). Jika ekstensi yang ditentukan sedang aktif dalam basis data, fungsi ini tidak akan menghapusnya. Anda harus secara eksplisit memanggil DROP EXTENSION untuk menghapus TLE ekstensi sebelum menggunakan fungsi ini untuk menghapus artefaknya.

Prototipe fungsi

pgtle.uninstall_extension_if_exists(extname text)

Peran

pgtle_admin

Argumen

  • extname— Nama TLE ekstensi. Nilai ini digunakan saat memanggil CREATE EXTENSION.

Output

Fungsi uninstall_extension_if_exists mengembalikan true setelah menghapus instalasi ekstensi yang ditentukan. Jika ekstensi yang ditentukan tidak ada, fungsi akan mengembalikan false.

  • true— Kembali true setelah mencopot pemasangan TLE ekstensi.

  • false— Kembali false ketika TLE ekstensi tidak ada dalam database.

Contoh penggunaan

SELECT * FROM pgtle.uninstall_extension_if_exists('pg_tle_test');

pgtle.uninstall_update_path

uninstall_update_pathFungsi menghapus jalur pembaruan tertentu dari TLE ekstensi. Fungsi ini membuat ALTER EXTENSION ... UPDATE TO tidak dapat menggunakan ekstensi ini sebagai jalur pembaruan.

Jika TLE ekstensi saat ini digunakan oleh salah satu versi di jalur pembaruan ini, ekstensi tetap ada di database.

Jika jalur pembaruan yang ditentukan tidak ada, fungsi akan memunculkan kesalahan.

Prototipe fungsi

pgtle.uninstall_update_path(extname text, fromvers text, tovers text)

Peran

pgtle_admin

Argumen

  • extname— Nama TLE ekstensi. Nilai ini digunakan saat memanggil CREATE EXTENSION.

  • fromvers— Versi sumber TLE ekstensi yang digunakan pada jalur pembaruan.

  • tovers— Versi tujuan TLE ekstensi yang digunakan pada jalur pembaruan.

Output

Tidak ada.

Contoh penggunaan

SELECT * FROM pgtle.uninstall_update_path('pg_tle_test', '0.1', '0.2');

pgtle.uninstall_update_path_if_exists

uninstall_update_path_if_existsFungsinya mirip uninstall_update_path dengan menghapus jalur pembaruan yang ditentukan dari TLE ekstensi. Namun, jika jalur pembaruan tidak ada, fungsi ini tidak memunculkan pesan kesalahan. Sebaliknya, fungsi mengembalikan false.

Prototipe fungsi

pgtle.uninstall_update_path_if_exists(extname text, fromvers text, tovers text)

Peran

pgtle_admin

Argumen

  • extname— Nama TLE ekstensi. Nilai ini digunakan saat memanggil CREATE EXTENSION.

  • fromvers— Versi sumber TLE ekstensi yang digunakan pada jalur pembaruan.

  • tovers— Versi tujuan TLE ekstensi yang digunakan pada jalur pembaruan.

Output

  • true— Fungsi telah berhasil memperbarui jalur untuk TLE ekstensi.

  • false— Fungsi tidak dapat memperbarui jalur untuk TLE ekstensi.

Contoh penggunaan

SELECT * FROM pgtle.uninstall_update_path_if_exists('pg_tle_test', '0.1', '0.2');

pgtle.unregister_feature

Fungsi unregister_feature menyediakan cara untuk menghapus fungsi yang terdaftar untuk menggunakan fitur pg_tle, seperti hook. Untuk informasi tentang pendaftaran fitur, lihat pgtle.register_feature.

Prototipe fungsi

pgtle.unregister_feature(proc regproc, feature pg_tle_features)

Peran

pgtle_admin

Argumen

  • proc – Nama fungsi tersimpan untuk mendaftar dengan fitur pg_tle.

  • feature – Nama fitur pg_tle untuk mendaftar dengan fungsi. Misalnya, passcheck adalah fitur yang dapat didaftarkan untuk digunakan oleh ekstensi bahasa tepercaya yang Anda kembangkan. Untuk informasi selengkapnya, lihat Hook pemeriksaan kata sandi (passcheck).

Output

Tidak ada.

Contoh penggunaan

SELECT * FROM pgtle.unregister_feature('pw_hook', 'passcheck');

pgtle.unregister_feature_if_exists

Fungsi unregister_feature menyediakan cara untuk menghapus fungsi yang terdaftar untuk menggunakan fitur pg_tle, seperti hook. Untuk informasi selengkapnya, lihat Menggunakan SQL kait Postgre dengan ekstensi Anda TLE. Mengembalikan true setelah berhasil membatalkan pendaftaran fitur. Mengembalikan false jika fitur tidak terdaftar.

Untuk informasi tentang mendaftarkan pg_tle fitur untuk TLE ekstensi Anda, lihatpgtle.register_feature.

Prototipe fungsi

pgtle.unregister_feature_if_exists('proc regproc', 'feature pg_tle_features')

Peran

pgtle_admin

Argumen

  • proc – Nama fungsi tersimpan yang terdaftar untuk menyertakan fitur pg_tle.

  • feature – Nama fitur pg_tle yang terdaftar dengan ekstensi bahasa tepercaya.

Output

Mengembalikan true atau false, sebagai berikut.

  • true – Fungsi telah berhasil membatalkan pendaftaran fitur dari ekstensi.

  • false— Fungsi tidak dapat membatalkan pendaftaran fitur dari TLE ekstensi.

Contoh penggunaan

SELECT * FROM pgtle.unregister_feature_if_exists('pw_hook', 'passcheck');