pgsql-jp.github.io/jpug-doc/13.1/html/adminpack.html at master · pgsql-jp/pgsql-jp.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>F.1. adminpack</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="prev" href="contrib.html" title="付録F 追加で提供されるモジュール" /><link rel="next" href="amcheck.html" title="F.2. amcheck" /><meta name="viewport" content="width=device-width,initial-scale=1.0" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="4" align="center"><a accesskey="h" href="index.html">PostgreSQL 13.1文書</a></th></tr><tr><td width="10%" align="left"></td><td width="10%" align="left"></td><td width="60%" align="center"><a href="contrib.html" title="付録F 追加で提供されるモジュール">付録F 追加で提供されるモジュール</a></td><td width="20%" align="right"><div class="actions"><a class="issue" title="github" href="https://github.com/pgsql-jp/jpug-doc/issues/new?title=version 13.1 &#10;                      adminpack.html">誤訳等の報告
                    </a></div></td></tr><tr><td width="10%" align="left"><a accesskey="p" href="contrib.html" title="付録F 追加で提供されるモジュール">前へ</a> </td><td width="10%" align="left"><a accesskey="u" href="contrib.html" title="付録F 追加で提供されるモジュール">上へ</a></td><td width="60%" align="center">F.1. adminpack</td><td width="20%" align="right"> <a accesskey="n" href="amcheck.html" title="F.2. amcheck">次へ</a></td></tr></table><hr /></div><div class="sect1" id="ADMINPACK"><div class="titlepage"><div><div><h2 class="title" style="clear: both">F.1. adminpack</h2></div></div></div><a id="id-1.11.7.10.2" class="indexterm"></a><p>
<span class="original">
  &lt;filename&gt;adminpack&lt;/filename&gt; provides a number of support functions which
  &lt;application&gt;pgAdmin&lt;/application&gt; and other administration and management tools can
  use to provide additional functionality, such as remote management
  of server log files.
  Use of all these functions is only allowed to the superuser by default but may be
  allowed to other users by using the &lt;command&gt;GRANT&lt;/command&gt; command.
</span>
<code class="filename">adminpack</code>は、<span class="application">pgAdmin</span>やその他の管理・運用ツールがサーバログファイルの遠隔管理を行うなどの、追加的な機能を提供できるようにするための数多くのサポート関数を提供します。
デフォルトでは、この関数の使用はすべてスーパーユーザに限定されていますが、<code class="command">GRANT</code>コマンドを使用して他のユーザーに許可されている場合があります。
 </p><p>
<span class="original">
  The functions shown in &lt;xref linkend="functions-adminpack-table"/&gt; provide
  write access to files on the machine hosting the server.  (See also the
  functions in &lt;xref linkend="functions-admin-genfile-table"/&gt;, which
  provide read-only access.)
  Only files within the database cluster directory can be accessed, unless the
  user is a superuser or given one of the pg_read_server_files, or pg_write_server_files
  roles, as appropriate for the function, but either a relative or absolute path is
  allowable.
</span>
<a class="xref" href="adminpack.html#FUNCTIONS-ADMINPACK-TABLE" title="表F.1 adminpack関数">表 F.1</a>に示す関数はサーバをホスティングしているマシン上のファイルに対して書き込みアクセスを提供します。
(<a class="xref" href="functions-admin.html#FUNCTIONS-ADMIN-GENFILE-TABLE" title="表9.95 汎用ファイルアクセス関数">表 9.95</a>の関数も参照してください。そちらは読み取り専用アクセスを提供します。)
ユーザがスーパーユーザか、関数に応じたpg_read_server_files、またはpg_write_server_filesロールのいずれかのロールを与えられていない限り、データベースクラスタディレクトリ内のファイルにのみアクセス可能です。
ただし、相対パスと絶対パスのどちらも利用できます。
 </p><div class="table" id="FUNCTIONS-ADMINPACK-TABLE"><p class="title"><strong>表F.1 <code class="filename">adminpack</code>関数</strong></p><div class="table-contents"><span class="original">
  &lt;title&gt;&lt;filename&gt;adminpack&lt;/filename&gt; Functions&lt;/title&gt;
</span><table class="table" summary="adminpack関数" border="1"><colgroup><col /></colgroup><thead><tr><th class="func_table_entry"><p class="func_signature">
<span class="original">
        Function
</span>
        関数
       </p>
       <p>
<span class="original">
        Description
</span>
        説明
       </p></th></tr></thead><tbody><tr><td class="func_table_entry"><p class="func_signature">
        <code class="function">pg_catalog.pg_file_write</code> ( <em class="parameter"><code>filename</code></em> <code class="type">text</code>, <em class="parameter"><code>data</code></em> <code class="type">text</code>, <em class="parameter"><code>append</code></em> <code class="type">boolean</code> )
        → <code class="returnvalue">bigint</code>
       </p>
       <p>
<span class="original">
        Writes, or appends to, a text file.
</span>
テキストファイルに書き込む、または追記する
       </p></td></tr><tr><td class="func_table_entry"><p class="func_signature">
        <code class="function">pg_catalog.pg_file_sync</code> ( <em class="parameter"><code>filename</code></em> <code class="type">text</code> )
        → <code class="returnvalue">void</code>
       </p>
       <p>
<span class="original">
        Flushes a file or directory to disk.
</span>
ファイルまたはディレクトリをディスクにフラッシュする
       </p></td></tr><tr><td class="func_table_entry"><p class="func_signature">
        <code class="function">pg_catalog.pg_file_rename</code> ( <em class="parameter"><code>oldname</code></em> <code class="type">text</code>, <em class="parameter"><code>newname</code></em> <code class="type">text</code> [<span class="optional">, <em class="parameter"><code>archivename</code></em> <code class="type">text</code> </span>] )
        → <code class="returnvalue">boolean</code>
       </p>
       <p>
<span class="original">
        Renames a file.
</span>
ファイル名を変更する
       </p></td></tr><tr><td class="func_table_entry"><p class="func_signature">
        <code class="function">pg_catalog.pg_file_unlink</code> ( <em class="parameter"><code>filename</code></em> <code class="type">text</code> )
        → <code class="returnvalue">boolean</code>
       </p>
       <p>
<span class="original">
        Removes a file.
</span>
ファイルを削除する
       </p></td></tr><tr><td class="func_table_entry"><p class="func_signature">
        <code class="function">pg_catalog.pg_logdir_ls</code> ()
        → <code class="returnvalue">setof record</code>
       </p>
       <p>
<span class="original">
        Lists the log files in the &lt;varname&gt;log_directory&lt;/varname&gt; directory.
</span>
<code class="varname">log_directory</code>ディレクトリ内のログファイルの一覧を表示する
       </p></td></tr></tbody></table></div></div><br class="table-break" /><a id="id-1.11.7.10.6" class="indexterm"></a><p>
<span class="original">
  &lt;function&gt;pg_file_write&lt;/function&gt; writes the specified &lt;parameter&gt;data&lt;/parameter&gt; into
  the file named by &lt;parameter&gt;filename&lt;/parameter&gt;.  If &lt;parameter&gt;append&lt;/parameter&gt; is
  false, the file must not already exist.  If &lt;parameter&gt;append&lt;/parameter&gt; is true,
  the file can already exist, and will be appended to if so.
  Returns the number of bytes written.
</span>
<code class="function">pg_file_write</code>は指定された<em class="parameter"><code>data</code></em>を<em class="parameter"><code>filename</code></em>で指定されたファイルに書き込みます
<em class="parameter"><code>append</code></em>が偽であれば、ファイルは既に存在していてはいけません。
<em class="parameter"><code>append</code></em>が真であれば、ファイルが既に存在していても構いません。その場合、追記されます。
書き込んだバイト数を返します。
 </p><a id="id-1.11.7.10.8" class="indexterm"></a><p>
<span class="original">
  &lt;function&gt;pg_file_sync&lt;/function&gt; fsyncs the specified file or directory
  named by &lt;parameter&gt;filename&lt;/parameter&gt;.  An error is thrown
  on failure (e.g., the specified file is not present). Note that
  &lt;xref linkend="guc-data-sync-retry"/&gt; has no effect on this function,
  and therefore a PANIC-level error will not be raised even on failure to
  flush database files.
</span>
<code class="function">pg_file_sync</code>は<em class="parameter"><code>filename</code></em>で指定されたファイルまたはディレクトリをfsyncします。
(例えば、指定されたファイルが存在しないなど)失敗するとエラーを発生します。
<a class="xref" href="runtime-config-error-handling.html#GUC-DATA-SYNC-RETRY">data_sync_retry</a>はこの関数には影響しませんので、データベースファイルのフラッシュの失敗であってもPANICレベルのエラーは起こらないことに注意してください。
 </p><a id="id-1.11.7.10.10" class="indexterm"></a><p>
<span class="original">
  &lt;function&gt;pg_file_rename&lt;/function&gt; renames a file.  If &lt;parameter&gt;archivename&lt;/parameter&gt;
  is omitted or NULL, it simply renames &lt;parameter&gt;oldname&lt;/parameter&gt;
  to &lt;parameter&gt;newname&lt;/parameter&gt; (which must not already exist).
  If &lt;parameter&gt;archivename&lt;/parameter&gt; is provided, it first
  renames &lt;parameter&gt;newname&lt;/parameter&gt; to &lt;parameter&gt;archivename&lt;/parameter&gt; (which must
  not already exist), and then renames &lt;parameter&gt;oldname&lt;/parameter&gt;
  to &lt;parameter&gt;newname&lt;/parameter&gt;.  In event of failure of the second rename step,
  it will try to rename &lt;parameter&gt;archivename&lt;/parameter&gt; back
  to &lt;parameter&gt;newname&lt;/parameter&gt; before reporting the error.
  Returns true on success, false if the source file(s) are not present or
  not writable; other cases throw errors.
</span>
<code class="function">pg_file_rename</code>はファイルの名前を変更します。
<em class="parameter"><code>archivename</code></em>が省略されたり、NULLである場合は、単純に<em class="parameter"><code>oldname</code></em>を<em class="parameter"><code>newname</code></em>(既に存在していてはいけません)に変更します。
<em class="parameter"><code>archivename</code></em>が指定されていれば、まず<em class="parameter"><code>newname</code></em>を<em class="parameter"><code>archivename</code></em>(既に存在していてはいけません)に変更し、それから<em class="parameter"><code>oldname</code></em>を<em class="parameter"><code>newname</code></em>に変更します。
第2段階の名前の変更が失敗した場合には、エラーを報告する前に<em class="parameter"><code>archivename</code></em>を<em class="parameter"><code>newname</code></em>に戻そうとします。
成功した場合には真を、元のファイルが存在しなかったり、書き込みできなかった場合には偽を返します。その他の場合にはエラーを発生します。
 </p><a id="id-1.11.7.10.12" class="indexterm"></a><p>
<span class="original">
  &lt;function&gt;pg_file_unlink&lt;/function&gt; removes the specified file.
  Returns true on success, false if the specified file is not present
  or the &lt;function&gt;unlink()&lt;/function&gt; call fails; other cases throw errors.
</span>
<code class="function">pg_file_unlink</code>は指定されたファイルを削除します。
成功した場合には真を、指定されたファイルが存在しなかったり、<code class="function">unlink()</code>の呼出しが失敗した場合には偽を返します。その他の場合にはエラーを発生します。
 </p><a id="id-1.11.7.10.14" class="indexterm"></a><p>
<span class="original">
  &lt;function&gt;pg_logdir_ls&lt;/function&gt; returns the start timestamps and path
  names of all the log files in the &lt;xref linkend="guc-log-directory"/&gt;
  directory.  The &lt;xref linkend="guc-log-filename"/&gt; parameter must have its
  default setting (&lt;literal&gt;postgresql-%Y-%m-%d_%H%M%S.log&lt;/literal&gt;) to use this
  function.
</span>
<code class="function">pg_logdir_ls</code>は<a class="xref" href="runtime-config-logging.html#GUC-LOG-DIRECTORY">log_directory</a>ディレクトリ内にあるログファイルすべての開始時のタイムスタンプとパス名を返します。
この関数を使うには、<a class="xref" href="runtime-config-logging.html#GUC-LOG-FILENAME">log_filename</a>パラメータはデフォルト設定(<code class="literal">postgresql-%Y-%m-%d_%H%M%S.log</code>)でなければなりません。
 </p></div><div xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navfooter"><hr></hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="contrib.html" title="付録F 追加で提供されるモジュール">前へ</a> </td><td width="20%" align="center"><a accesskey="u" href="contrib.html" title="付録F 追加で提供されるモジュール">上へ</a></td><td width="40%" align="right"> <a accesskey="n" href="amcheck.html" title="F.2. amcheck">次へ</a></td></tr><tr><td width="40%" align="left" valign="top">付録F 追加で提供されるモジュール </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 13.1文書">ホーム</a></td><td width="40%" align="right" valign="top"> F.2. amcheck</td></tr></table></div></body></html>