]> begriffs open source - ai-pg/blob - full-docs/man1/pg_test_fsync.1
Convert HTML docs to more streamlined TXT
[ai-pg] / full-docs / man1 / pg_test_fsync.1
1 '\" t
2 .\"     Title: pg_test_fsync
3 .\"    Author: The PostgreSQL Global Development Group
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\"      Date: 2025
6 .\"    Manual: PostgreSQL 18.0 Documentation
7 .\"    Source: PostgreSQL 18.0
8 .\"  Language: English
9 .\"
10 .TH "PG_TEST_FSYNC" "1" "2025" "PostgreSQL 18.0" "PostgreSQL 18.0 Documentation"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 pg_test_fsync \- determine fastest \fIwal_sync_method\fR for PostgreSQL
32 .SH "SYNOPSIS"
33 .HP \w'\fBpg_test_fsync\fR\ 'u
34 \fBpg_test_fsync\fR [\fIoption\fR...]
35 .SH "DESCRIPTION"
36 .PP
37 pg_test_fsync
38 is intended to give you a reasonable idea of what the fastest
39 wal_sync_method
40 is on your specific system, as well as supplying diagnostic information in the event of an identified I/O problem\&. However, differences shown by
41 pg_test_fsync
42 might not make any significant difference in real database throughput, especially since many database servers are not speed\-limited by their write\-ahead logs\&.
43 pg_test_fsync
44 reports average file sync operation time in microseconds for each
45 wal_sync_method, which can also be used to inform efforts to optimize the value of
46 commit_delay\&.
47 .SH "OPTIONS"
48 .PP
49 pg_test_fsync
50 accepts the following command\-line options:
51 .PP
52 \fB\-f\fR
53 .br
54 \fB\-\-filename\fR
55 .RS 4
56 Specifies the file name to write test data in\&. This file should be in the same file system that the
57 pg_wal
58 directory is or will be placed in\&. (pg_wal
59 contains the
60 WAL
61 files\&.) The default is
62 pg_test_fsync\&.out
63 in the current directory\&.
64 .RE
65 .PP
66 \fB\-s\fR
67 .br
68 \fB\-\-secs\-per\-test\fR
69 .RS 4
70 Specifies the number of seconds for each test\&. The more time per test, the greater the test\*(Aqs accuracy, but the longer it takes to run\&. The default is 5 seconds, which allows the program to complete in under 2 minutes\&.
71 .RE
72 .PP
73 \fB\-V\fR
74 .br
75 \fB\-\-version\fR
76 .RS 4
77 Print the
78 pg_test_fsync
79 version and exit\&.
80 .RE
81 .PP
82 \fB\-?\fR
83 .br
84 \fB\-\-help\fR
85 .RS 4
86 Show help about
87 pg_test_fsync
88 command line arguments, and exit\&.
89 .RE
90 .SH "ENVIRONMENT"
91 .PP
92 The environment variable
93 \fBPG_COLOR\fR
94 specifies whether to use color in diagnostic messages\&. Possible values are
95 always,
96 auto
97 and
98 never\&.
99 .SH "SEE ALSO"
100 \fBpostgres\fR(1)