From 2f243b8f08dba3426c4a3d3734cb352c5b54fbf0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Markus=20M=C3=A4kel=C3=A4?= Date: Fri, 12 Apr 2019 13:00:09 +0300 Subject: [PATCH] MXS-2349: Document `socket` Added documentation for the parameter and changed the minimum required server definition in the REST API. --- Documentation/Getting-Started/Configuration-Guide.md | 6 ++++++ Documentation/REST-API/Resources-Server.md | 9 ++++++--- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/Documentation/Getting-Started/Configuration-Guide.md b/Documentation/Getting-Started/Configuration-Guide.md index 4ef43775a..facc1969f 100644 --- a/Documentation/Getting-Started/Configuration-Guide.md +++ b/Documentation/Getting-Started/Configuration-Guide.md @@ -1469,6 +1469,12 @@ The port on which the database listens for incoming connections. MariaDB MaxScale will use this port to connect to the database server. The default value is 3306. +#### `socket` + +The absolute path to a UNIX domain socket the MariaDB server is listening +on. Either `address` or `socket` must be defined and defining them both is an +error. + #### `protocol` The name for the protocol module to use to connect MariaDB MaxScale to the diff --git a/Documentation/REST-API/Resources-Server.md b/Documentation/REST-API/Resources-Server.md index 4ef3321ee..30772b651 100644 --- a/Documentation/REST-API/Resources-Server.md +++ b/Documentation/REST-API/Resources-Server.md @@ -241,11 +241,14 @@ least the following fields. * `data.type` * Type of the object, must be `servers` -* `data.attributes.parameters.address` - * The [`address`](../Getting-Started/Configuration-Guide.md#address) to use +* `data.attributes.parameters.address` OR `data.attributes.parameters.socket` + * The [`address`](../Getting-Started/Configuration-Guide.md#address) or + [`socket`](../Getting-Started/Configuration-Guide.md#socket) to use. Only + one of the fields can be defined. * `data.attributes.parameters.port` - * The [`port`](../Getting-Started/Configuration-Guide.md#port) to use + * The [`port`](../Getting-Started/Configuration-Guide.md#port) to use. Needs + to be defined if the `address` field is defined. The following is the minimal required JSON object for defining a new server.