Updated documentation

Author: iagaponenko

doc/ingest/api/index.rst

@@ -1,7 +1,7 @@
 
 .. note::
 
-   Information in this guide corresponds to the version **39** of the Qserv REST API. Keep in mind
+   Information in this guide corresponds to the version **49** of the Qserv REST API. Keep in mind
    that each implementation of the API has a specific version. The version number will change
    if any changes to the implementation or the API that might affect users will be made.
    The current document will be kept updated to reflect the latest version of the API.

doc/ingest/api/reference/rest/controller/db-table-management.rst

@@ -46,6 +46,8 @@ that has the following schema (of which only the database and database family-re
                             "latitude_key" :            "coord_dec",
                             "create_time" :             1662774817703,
                             "unique_primary_key" :      1,
+                            "charset_name" :            "latin1",
+                            "collation_name" :          "latin1_swedish_ci",
                             "flag" :                    "",
                             "name" :                    "Source",
                             "director_database_name" :  "",
@@ -221,7 +223,9 @@ the **partitioned** tables is presented below:
         "longitude_key"        : <string>,
         "flag"                 : <string>,
         "ang_sep"              : <double>,
-        "unique_primary_key"   : <number>
+        "unique_primary_key"   : <number>,
+        "charset_name"         : <string>,
+        "collation_name"       : <string>
     }
 
 A description of the *regular* tables has a fewer number of attributes (attributes that which are specific to the *partitioned*
@@ -317,6 +321,13 @@ Where the attributes are:
   - ``0``: The primary key is not unique.
   - ``1``: The primary key is unique.
 
+``charset_name`` : *part* = ``latin1``
+  The optional parameter that affects the interpretation of the data in the CSV file when ingesting the contribution.
+  The name will be also used for setting the ``CHARSET`` attribute of the relevant MySQL tables created by the service.
+
+``collation_name`` : *part* = ``latin1_swedish_ci``
+  The optional parameter is used for setting the ``COLLATE`` attribute of the relevant MySQL tables created by the service.
+
 .. warning::
 
     - The table schema does not include definitions of indexes. Those are managed separately after the table is published.

doc/user/http-frontend-ingest.rst

@@ -79,9 +79,8 @@ Most services described in this document require user database and table names.
   This prefix is reserved for naming internal tables that Qserv places into user databases.
 
 Depending on the version of the Qserv AOI, there are additional restrictions on the names of databases and tables.
-Before version number **46** of the API, database and table names could only container alphanumeric characters and underscores.
-This restriction was imposed to avoid issues with the MySQL server. This restriction was relaxed in version **46** of the API
-to allow the following special characters:
+Before version number **46** of the API, database and table names could only contain alphanumeric characters and underscores.
+This restriction is relaxed as of version **46** of the API to allow the following special characters:
 
   -       (white space)
   - ``-`` (hyphen)
@@ -140,6 +139,8 @@ to specify the operation to be performed. The object follows this schema:
     {   "database" :        <string>,
         "table" :           <string>,
         "binary_encoding" : <string>,
+        "charset_name" :    <string>,
+        "collation_name" :  <string>,
         "timeout" :         <number>,
         "schema" :          <array>,
         "indexes" :         <array>,
@@ -159,6 +160,13 @@ Where:
 
   - :ref:`ingest-general-binary-encoding` (REST)
 
+``charset_name`` : *part* = ``latin1``
+  The optional parameter that affects the interpretation of the data in the CSV file when ingesting the contribution.
+  The name will be used for setting the ``CHARSET`` attribute of the relevant MySQL tables created by the service.
+
+``collation_name`` : *part* = ``latin1_swedish_ci``
+  The optional parameter is used for setting the ``COLLATE`` attribute of the relevant MySQL tables created by the service.
+
 ``schema`` : *array*
   The required schema definition. The schema must be a JSON array, where each entry represents a column specification.
   More information on the schema specification requirements can be found in the dedicated section of the document:
@@ -328,11 +336,11 @@ and files:
   The default value assumes the newline character.
 
 ``charset_name`` : *part* = ``latin1``
-  The optional parameters specify the desired character set name to be assumed when ingesting
-  the contribution. The default value may be also affected by the ingest services configuration.
-  See the following document for more details:
+  The optional parameter that affects the interpretation of the data in the CSV file when ingesting the contribution.
+  The name will be also used for setting the ``CHARSET`` attribute of the relevant MySQL tables created by the service.
 
-  - :ref:`ingest-api-advanced-charset` (ADVANCED)
+``collation_name`` : *part* = ``latin1_swedish_ci``
+  The optional parameter is used for setting the ``COLLATE`` attribute of the relevant MySQL tables created by the service.
 
 ``timeout`` : *part* = ``300``
   The optional timeout (in seconds) that limits the duration of the internal operations initiated by the service.
@@ -398,6 +406,8 @@ The request could be pushed to the service using:
          -F 'table=employee' \
          -F 'fields_terminated_by=,' \
          -F 'timeout=300' \
+         -F 'charset_name=utf8mb4' \
+         -F 'collation_name=utf8mb4_uca1400_ai_ci' \
          -F 'schema=@/path/to/schema.json' \
          -F 'indexes=@/path/to/indexes.json' \ 
          -F 'rows=@/path/to/employee.csv'

doc/user/http-frontend.rst

@@ -1,7 +1,7 @@
 
 .. note::
 
-  - This guide corresponds to version **47** of the Qserv REST API. Note that each API implementation has a specific version.
+  - This guide corresponds to version **49** of the Qserv REST API. Note that each API implementation has a specific version.
     The version number will change if any modifications to the implementation or API that might affect users are made.
     This document will be updated to reflect the latest API version.
   - All communications with the service are over SSL/TLS encrypted connections.