Pipelines PGFS reference
========================

EDB Postgres AI -
AIアクセラレーターパイプラインPGFSのこのリファレンスドキュメントには、 :ref:`Pipelines PGFS reference <Pipelines PGFS reference>` 拡張機能で使用可能なファンクションとビューに関する情報が含まれています。これらの機能は、
AIDBにS3互換ファイルシステム、Google Cloud
Storageバケット、ローカルファイルシステムへのアクセスを提供します。

pgfs
----

ファンクション
^^^^^^^^^^^^^^

- :ref:`pgfs.create_foreign_table <pgfs.create_foreign_table>` 

- :ref:`pgfs.create_storage_location <pgfs.create_storage_location>` 

- :ref:`pgfs.create_storage_location_with_foreign_table <pgfs.create_storage_location_with_foreign_table>` 

- :ref:`pgfs.delete_storage_location <pgfs.delete_storage_location>` 

- :ref:`pgfs.list_storage_locations <pgfs.list_storage_locations>` 

- :ref:`pgfs.get_storage_location <pgfs.get_storage_location>` 

- :ref:`pgfs.update_storage_location <pgfs.update_storage_location>` 

.. _ファンクション-1:

ファンクション
--------------

pgfs.create_foreign_table
^^^^^^^^^^^^^^^^^^^^^^^^^

データベースに外部テーブルを作成します。

パラメーター
^^^^^^^^^^^^

.. csv-table::
  :header: Parameter,Type,Default,Description
  :widths: 15,12,12,20
  :align: left
  :class: longtable

  `table_name`,text,"",NA
  `server_name`,text,"",NA

例
^^

.. code:: sql

   SELECT pgfs.create_foreign_table(my_table, my_server);

pgfs.create_storage_location
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

データベースに保存場所を作成します。

.. _パラメーター-1:

パラメーター
^^^^^^^^^^^^

.. csv-table::
  :header: Parameter,Type,Default,Description
  :widths: 15,12,12,20
  :align: left
  :class: longtable

  `name`,text,"",保存場所の名前
  `url`,text,"",この保存場所のURL接頭辞`s3:`、`gs:`、または`file:`
  `options`,json,"",保存場所のオプションオプショナル
  `credentials`,json,"",保存場所の資格情報オプショナル

**または**

.. csv-table::
  :header: Parameter,Type,Default,Description
  :widths: 15,12,12,20
  :align: left
  :class: longtable

  `name`,text,"",保存場所の名前
  `url`,text,"",この保存場所のURL接頭辞`s3:`、`gs:`、または`file:`
  `msl_id`,uuid,"",未使用
  `options`,json,"",保存場所のオプションオプショナル
  `credentials`,json,"",保存場所の資格情報オプショナル

.. _例-1:

例
^^

.. code:: sql

   SELECT pgfs.create_storage_location(my_storage, 
                                       s3://my_bucket, 123e4567-e89b-12d3-a456-426614174000, 
                                       {}, 
                                       {});

pgfs.create_storage_location_with_foreign_table
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

データベースに格納場所を作成し、外部テーブルに関連付けます。

.. _パラメーター-2:

パラメーター
^^^^^^^^^^^^

.. csv-table::
  :header: Parameter,Type,Default,Description
  :widths: 15,12,12,20
  :align: left
  :class: longtable

  `storage_location_name`,text,"",保存場所の名前
  `url`,text,"",この保存場所のURL接頭辞`s3:`、`gs:`または`file:`
  `options`,json,"",保存場所のオプションオプショナル
  `credentials`,json,"",保存場所の資格情報オプショナル

**または**

.. csv-table::
  :header: Parameter,Type,Default,Description
  :widths: 15,12,12,20
  :align: left
  :class: longtable

  `storage_location_name`,text,"",保存場所の名前
  `url`,text,"",この保存場所のURL接頭辞`s3:`、`gs:`または`file:`
  `msl_id`,uuid,"",未使用
  `options`,json,"",保存場所のオプションオプショナル
  `credentials`,json,"",保存場所の資格情報オプショナル

.. _例-2:

例
^^

.. code:: sql

   SELECT pgfs.create_storage_location_with_foreign_table(my_storage, 
                                                          s3://my_bucket, 123e4567-e89b-12d3-a456-426614174000, 
                                                          {}, 
                                                          {});

pgfs.delete_storage_location
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

データベースから保存場所を削除します。

.. _パラメーター-3:

パラメーター
^^^^^^^^^^^^

.. csv-table::
  :header: Parameter,Type,Default,Description
  :widths: 15,12,12,20
  :align: left
  :class: longtable

  `storage_location_name`,text,"",保存場所の名前

.. _例-3:

例
^^

.. code:: sql

   SELECT pgfs.delete_storage_location(my_storage);

pgfs.get_default_storage_location
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

デフォルトの保存場所を返します。

返品
^^^^

.. csv-table::
  :header: Column,Type,Description
  :widths: 12,15,25
  :align: left
  :class: longtable

  `default_storage_location`,text,NA

.. _例-4:

例
^^

.. code:: sql

   SELECT * FROM pgfs.get_default_storage_location();

pgfs.get_storage_location
^^^^^^^^^^^^^^^^^^^^^^^^^

保存場所に関する情報を返します。

.. _パラメーター-4:

パラメーター
^^^^^^^^^^^^

.. csv-table::
  :header: Parameter,Type,Default,Description
  :widths: 15,12,12,20
  :align: left
  :class: longtable

  `storage_location_name`,text,"",保存場所の名前

.. _返品-1:

返品
^^^^

.. csv-table::
  :header: Column,Type,Description
  :widths: 12,15,25
  :align: left
  :class: longtable

  `name`,text,NA
  `url`,text,NA
  `msl_id`,uuid,NA
  `options`,json,NA
  `credentials`,json,NA

.. _例-5:

例
^^

.. code:: sql

   SELECT * FROM pgfs.get_storage_location(my_storage);

pgfs.list_storage_locations
^^^^^^^^^^^^^^^^^^^^^^^^^^^

データベース内のすべての保存場所をリストします。

.. _返品-2:

返品
^^^^

.. csv-table::
  :header: Column,Type,Description
  :widths: 12,15,25
  :align: left
  :class: longtable

  `name`,text,NA
  `url`,text,NA
  `msl_id`,uuid,NA
  `options`,json,NA
  `credentials`,json,NA

.. _例-6:

例
^^

.. code:: sql

   SELECT * FROM pgfs.list_storage_locations();

pgfs.set_default_storage_location
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

デフォルトの保存場所を設定します。

.. _パラメーター-5:

パラメーター
^^^^^^^^^^^^

.. csv-table::
  :header: Parameter,Type,Default,Description
  :widths: 15,12,12,20
  :align: left
  :class: longtable

  `storage_location_name`,text,"",NA

.. _例-7:

例
^^

.. code:: sql

   SELECT pgfs.set_default_storage_location(my_storage);

pgfs.update_storage_location
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

データベース内の保存場所を更新します。

.. _パラメーター-6:

パラメーター
^^^^^^^^^^^^

.. csv-table::
  :header: Parameter,Type,Default,Description
  :widths: 15,12,12,20
  :align: left
  :class: longtable

  `name`,text,"",NA
  `url`,text,"",NA
  `msl_id`,uuid,"",NA
  `options`,json,"",NA
  `credentials`,json,"",NA

.. _例-8:

例
^^

.. code:: sql

   SELECT pgfs.update_storage_location(my_storage, s3://my_bucket, 123e4567-e89b-12d3-a456-426614174000, {}, {});

ビュー
------

``pgfs`` スキーマには、ユーザー向けビューがありません。

テーブル
--------

``pgfs`` スキーマにはユーザー向けテーブルがありません。