summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristopher Baines <mail@cbaines.net>2020-10-02 19:06:50 +0100
committerChristopher Baines <mail@cbaines.net>2020-10-20 22:39:43 +0100
commita698df72d37aa5173c357b7d1e3873d2c2c64c32 (patch)
tree5ad67ce5ea44da50d16b43fc8bbf5962a175cf7e /doc
parent93576e4475c7f72a2f8aa05293244f9f669154a3 (diff)
services: databases: Deprecate the postgresql-service procedure.
Using the service type directly is a better approach, making it easier to configure the service. * gnu/services/databases.scm (postgresql-service): Deprecate this procedure. * doc/guix.texi (PostgreSQL): Update the documentation for the use of (service postgresql-service-type).
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi40
1 files changed, 31 insertions, 9 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 9a80555827..582ab0fd2b 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -18453,15 +18453,12 @@ The @code{(gnu services databases)} module provides the following services.
@subsubheading PostgreSQL
-@deffn {Scheme Procedure} postgresql-service [#:postgresql postgresql] @
- [#:config-file] [#:data-directory ``/var/lib/postgresql/data''] @
- [#:port 5432] [#:locale ``en_US.utf8''] [#:extension-packages '()]
-Return a service that runs @var{postgresql}, the PostgreSQL database
-server.
+The following example describes a PostgreSQL service with the default
+configuration.
-The PostgreSQL daemon loads its runtime configuration from @var{config-file},
-creates a database cluster with @var{locale} as the default
-locale, stored in @var{data-directory}. It then listens on @var{port}.
+@lisp
+(service postgresql-service-type)
+@end lisp
If the services fails to start, it may be due to an incompatible
cluster already present in @var{data-directory}. Adjust it (or, if you
@@ -18481,6 +18478,29 @@ createuser --interactive
createdb $MY_USER_LOGIN # Replace appropriately.
@end example
+@deftp {Data Type} postgresql-configuration
+Data type representing the configuration for the
+@code{postgresql-service-type}.
+
+@table @asis
+@item @var{postgresql} (default: @code{postgresql})
+PostgreSQL package to use for the service.
+
+@item @var{port} (default: @code{5432})
+Port on which PostgreSQL should listen.
+
+@item @var{locale} (default: @code{"en_US.utf8"})
+Locale to use as the default when creating the database cluster.
+
+@item @var{config-file} (default: @code{(postgresql-config-file)})
+The configuration file to use when running PostgreSQL. The default
+behaviour uses the postgresql-config-file record with the default values
+for the fields.
+
+@item @var{data-directory} (default: @code{"/var/lib/postgresql/data"})
+Directory in which to store the data.
+
+@item @var{extension-packages} (default: @code{'()})
@cindex postgresql extension-packages
Additional extensions are loaded from packages listed in
@var{extension-packages}. Extensions are available at runtime. For instance,
@@ -18516,7 +18536,9 @@ psql -U postgres
There is no need to add this field for contrib extensions such as hstore or
dblink as they are already loadable by postgresql. This field is only
required to add extensions provided by other packages.
-@end deffn
+
+@end table
+@end deftp
@subsubheading MariaDB/MySQL