From baa5adb2aeabdbbc60c697ee27082533c3d6aeca Mon Sep 17 00:00:00 2001 From: Yaniv Gerowitz Date: Thu, 10 Jun 2021 22:46:33 +0300 Subject: [PATCH 1/3] Updated connector links in index.rst See email I sent to Irina titled **Connectors packages in SQream official documentation** on 6/10/2021. There are open questions in that email. --- guides/client_drivers/index.rst | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/guides/client_drivers/index.rst b/guides/client_drivers/index.rst index 77fd14e15..077b753e4 100644 --- a/guides/client_drivers/index.rst +++ b/guides/client_drivers/index.rst @@ -1,19 +1,19 @@ .. _client_drivers: ************************************ -Client drivers for |latest_version| +Client Drivers for |latest_version| ************************************ -These guides explain how to use the SQream DB client drivers, and how to use client applications with SQream DB. +The guides on this page describe how to use the Sqream DB client drivers and client applications with Sqream DB. -Client driver downloads +Client Driver Downloads ============================= -All operating systems +All Operating Systems --------------------------- +The following drivers are applicable to all operating systems: -* - **JDBC** - `sqream-jdbc v4.3.3 (.jar) `_ +* **JDBC** - `sqream-jdbc v4.3.3 (.jar) `_ :ref:`java_jdbc` Driver @@ -27,7 +27,7 @@ All operating systems (SQream recommends installing via ``pip``) * - **Node.JS** - `sqream-v4.2.4 (.tar.gz) `_ + **Node.JS** - `sqream-v4.2.4 (.tar.gz) `_ :ref:`nodejs` - Node.JS driver @@ -51,7 +51,7 @@ Windows :ref:`Windows installer for ODBC and JDBC`, with Tableau customizations. Please contact your SQream representative to get this installer. -* **.Net driver** - `SQream .Net driver v2.0.0 `_ +* **.Net driver** - `SQream .Net driver v2.0.0 `_ @@ -59,12 +59,12 @@ Linux -------------- * - **SQream SQL** (x86) - `sqream-sql-v2020.1.1_stable.x86_64.tar.gz `_ + **SQream SQL** (x86) - `sqream-sql-v2020.1.1_stable.x86_64.tar.gz `_ :ref:`sqream sql` - Interactive command-line SQL client for Intel-based machines * - **SQream SQL** (IBM POWER9) - `sqream-sql-v2020.1.1_stable.ppc64le.tar.gz `_ + **SQream SQL** (IBM POWER9) - `sqream-sql-v2020.1.1_stable.ppc64le.tar.gz `_ :ref:`sqream sql` - Interactive command-line SQL client for IBM POWER9-based machines @@ -74,14 +74,14 @@ Linux :ref:`Linux installer for ODBC`. Please contact your SQream representative to get this installer. * - **C++ connector** - `libsqream-4.0 `_ + **C++ connector** - `libsqream-4.0 `_ :ref:`C++ shared object` library .. toctree:: :maxdepth: 4 - :caption: Client driver documentation: + :caption: Client Driver Documentation: :titlesonly: python/index From f20f29d7e59ac4e6088e079332c8ba8503514250 Mon Sep 17 00:00:00 2001 From: Yaniv Gerowitz Date: Fri, 11 Jun 2021 01:39:34 +0300 Subject: [PATCH 2/3] Updated content guides/client_drivers/index: * Updated links: * Improved page structure reference/cli/index: Capitalization reference/cli/sqream_sql: * Capitalization * Table widths * Table wording --- guides/client_drivers/index.rst | 82 +++++++++++++++------------- reference/cli/index.rst | 10 ++-- reference/cli/sqream_sql.rst | 96 ++++++++++++++++----------------- 3 files changed, 99 insertions(+), 89 deletions(-) diff --git a/guides/client_drivers/index.rst b/guides/client_drivers/index.rst index 077b753e4..d1a52601b 100644 --- a/guides/client_drivers/index.rst +++ b/guides/client_drivers/index.rst @@ -11,55 +11,65 @@ Client Driver Downloads All Operating Systems --------------------------- -The following drivers are applicable to all operating systems: +The following are applicable to all operating systems: -* **JDBC** - `sqream-jdbc v4.3.3 (.jar) `_ - - :ref:`java_jdbc` Driver - - (SQream recommends installing via ``mvn``) +.. _jdbc: + +* **JDBC** - recommended installation via ``mvn``: + + * `JDBC .jar file `_ - sqream-jdbc-4.4.0 (.jar) + * `JDBC driver `_ + + +.. _python: + +* **Python** - Recommended installation via ``pip``: + + * `Python .tar file `_ - pysqream v3.1.3 (.tar.gz) + * `Python driver `_ + + +.. _nodejs: + +* **Node.JS** - Recommended installation via ``npm``: + + * `Node.JS `_ - sqream-v4.2.4 (.tar.gz) + * `Node.JS driver `_ + + +.. _tableau_connector: + +* **Tableau**: + + * `Tableau connector `_ - SQreamDB (.taco) + * `Tableau manual installation `_ -* - **Python** - `pysqream v3.1.3 (.tar.gz) `_ - - :ref:`pysqream` - Python driver - - (SQream recommends installing via ``pip``) -* - **Node.JS** - `sqream-v4.2.4 (.tar.gz) `_ - - :ref:`nodejs` - Node.JS driver - - (SQream recommends installing via ``npm``) -* - **Tableau Connector** - `SQreamDB (.taco) `_ - - :ref:`Tableau connector` - Tableau connector for manual installation Windows -------------- +The following are applicable to Windows: -* - **JDBC installer** - `SQream_JDBC_Driver_v2020.2.0.exe `_ - - Windows installer for JDBC driver, with Tableau connector. -* - **ODBC installer** - ``SQream Drivers v2020.2.0`` - - :ref:`Windows installer for ODBC and JDBC`, with Tableau customizations. Please contact your SQream representative to get this installer. +* **JDBC installer** - `SQream_JDBC_Driver_v2020.2.0.exe `_ - Windows installer for JDBC driver, with Tableau connector. -* **.Net driver** - `SQream .Net driver v2.0.0 `_ +* **ODBC installer** - SQream Drivers v2020.2.0 - with Tableau customizations. Please contact your `Sqream represenative `_ for this installer. + + For more information on installing and configuring ODBC on Windows, see :ref:`Install and configure ODBC on Windows `. + +**Comment - I made the link to the Support Center on the Sqream website, but it says that I don't have permissions to view that portal. If I don't have permissions, then a front-end user probably doesn't either.** + +* **Net driver** - `SQream .Net driver v3.0.2 `_ Linux -------------- +The following are applicable to Linux: * - **SQream SQL** (x86) - `sqream-sql-v2020.1.1_stable.x86_64.tar.gz `_ + **SQream SQL** (x86_64) - `sqream-sql-v2020.1.1_stable.x86_64.tar.gz `_ :ref:`sqream sql` - Interactive command-line SQL client for Intel-based machines @@ -74,7 +84,7 @@ Linux :ref:`Linux installer for ODBC`. Please contact your SQream representative to get this installer. * - **C++ connector** - `libsqream-4.0 `_ + **C++ connector** - `libsqream-4.1 `_ :ref:`C++ shared object` library @@ -84,11 +94,11 @@ Linux :caption: Client Driver Documentation: :titlesonly: - python/index - cpp/index jdbc/index - odbc/index + python/index nodejs/index + odbc/index + cpp/index diff --git a/reference/cli/index.rst b/reference/cli/index.rst index d892ffea6..463a40607 100644 --- a/reference/cli/index.rst +++ b/reference/cli/index.rst @@ -1,10 +1,10 @@ .. _cli_reference: ************************ -Command line programs +Command Line Programs ************************ -SQream contains several command line programs for using, starting, managing, and configuring SQream DB clusters. +Sqream contains several command line programs for using, starting, managing, and configuring SQream DB clusters. This topic contains the reference for these programs, as well as flags and configuration settings. @@ -17,7 +17,7 @@ This topic contains the reference for these programs, as well as flags and confi * - :ref:`sqream sql` - Built-in SQL client -.. list-table:: SQream DB cluster components +.. list-table:: SQream DB Cluster Components :widths: auto :header-rows: 1 @@ -30,7 +30,7 @@ This topic contains the reference for these programs, as well as flags and confi * - :ref:`server_picker ` - Load balancer end-point -.. list-table:: SQream DB utilities +.. list-table:: Sqream DB Utilities :widths: auto :header-rows: 1 @@ -41,7 +41,7 @@ This topic contains the reference for these programs, as well as flags and confi * - :ref:`upgrade_storage ` - Upgrade metadata schemas when upgrading between major versions -.. list-table:: Docker utilities +.. list-table:: Docker Utilities :widths: auto :header-rows: 1 diff --git a/reference/cli/sqream_sql.rst b/reference/cli/sqream_sql.rst index 079f1543d..a171359a1 100644 --- a/reference/cli/sqream_sql.rst +++ b/reference/cli/sqream_sql.rst @@ -1,7 +1,7 @@ .. _sqream_sql_cli_reference: ********************************* -sqream sql CLI reference +Sqream SQL CLI Reference ********************************* SQream DB comes with a built-in client for executing SQL statements either interactively or from the command-line. @@ -11,7 +11,7 @@ This page serves as a reference for the options and parameters. Learn more about .. contents:: In this topic: :local: -Installing sqream sql +Installing Sqream SQL ========================= If you have a SQream DB installation on your server, ``sqream sql`` can be found in the ``bin`` directory of your SQream DB installation, under the name ``sqream``. @@ -40,7 +40,7 @@ To run ``sqream sql`` on any other Linux host: master=> _ -Troubleshooting sqream sql installation +Troubleshooting Sqream SQL Installation ------------------------------------------- Upon running sqream sql for the first time, you may get an error ``error while loading shared libraries: libtinfo.so.5: cannot open shared object file: No such file or directory``. @@ -69,12 +69,12 @@ Solving this error requires installing the ncruses or libtinfo libraries, depend ``$ sudo ln -s /usr/lib64/libtinfo.so.6 /usr/lib64/libtinfo.so.5`` -Using sqream sql +Using Sqream SQL ================= By default, sqream sql runs in interactive mode. You can issue commands or SQL statements. -Running commands interactively (SQL shell) +Running Commands Interactively (SQL shell) -------------------------------------------- When starting sqream sql, after entering your password, you are presented with the SQL shell. @@ -138,7 +138,7 @@ The prompt for a multi-line statement will change from ``=>`` to ``.``, to alert time: 0.009320s -Executing batch scripts (``-f``) +Executing Batch Scripts (``-f``) --------------------------------- To run an SQL script, use the ``-f `` argument. @@ -151,7 +151,7 @@ For example, .. tip:: Output can be saved to a file by using redirection (``>``). -Executing commands immediately (``-c``) +Executing Commands Immediately (``-c``) ------------------------------------------- To run a statement from the console, use the ``-c `` argument. @@ -175,7 +175,7 @@ For example, Examples =========== -Start a regular interactive shell +Starting a Regular Interactive Shell ----------------------------------- Connect to local server 127.0.0.1 on port 5000, to the default built-in database, `master`: @@ -202,7 +202,7 @@ Connect to local server 127.0.0.1 via the built-in load balancer on port 3108, t master=>_ -Execute statements in the interactive shell +Executing Statements in an Interactive Shell ----------------------------------------------- Note that all SQL commands end with a semicolon. @@ -243,7 +243,7 @@ Creating a new database and switching over to it without reconnecting: 2 rows time: 0.029299s -Execute SQL statements from the command line +Executing SQL Statements from the Command Line ---------------------------------------------- .. code-block:: console @@ -255,7 +255,7 @@ Execute SQL statements from the command line .. _controlling_output: -Controlling the output of the client +Controlling the Client Output ---------------------------------------- Two parameters control the dispay of results from the client: @@ -263,7 +263,7 @@ Two parameters control the dispay of results from the client: * ``--results-only`` - removes row counts and timing information * ``--delimiter`` - changes the record delimiter -Export SQL query result to CSV +Exporting SQL Query Results to CSV ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Using the ``--results-only`` flag removes the row counts and timing. @@ -277,7 +277,7 @@ Using the ``--results-only`` flag removes the row counts and timing. 3,chicken ,0 4,bull ,1 -Change a CSV to a TSV +Changing a CSV to a TSV ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The ``--delimiter`` parameter accepts any printable character. @@ -294,7 +294,7 @@ The ``--delimiter`` parameter accepts any printable character. 4 bull 1 -Execute a series of statements from a file +Executing a Series of Statements From a File -------------------------------------------- Assuming a file containing SQL statements (separated by semicolons): @@ -317,7 +317,7 @@ Assuming a file containing SQL statements (separated by semicolons): executed time: 0.090697s -Connect using environment variables +Connecting Using Environment Variables ------------------------------------- You can save connection parameters as environment variables: @@ -328,10 +328,10 @@ You can save connection parameters as environment variables: $ export SQREAM_DATABASE=farm; $ sqream sql --port=3105 --clustered --username=$SQREAM_USER -d $SQREAM_DATABASE -Connecting to a specific queue +Connecting to a Specific Queue ----------------------------------- -When using the :ref:`dynamic workload manager` - connect to ``etl`` queue instead of using the default ``sqream`` queue +When using the :ref:`dynamic workload manager` - connect to ``etl`` queue instead of using the default ``sqream`` queue. .. code-block:: psql @@ -344,13 +344,13 @@ When using the :ref:`dynamic workload manager` - connect to `` master=>_ -Operations and flag reference +Operations and Flag References =============================== -Command line arguments +Command Line Arguments ----------------------- -**SQream SQL** supports the following command line arguments: +**Sqream SQL** supports the following command line arguments: .. list-table:: :widths: auto @@ -400,7 +400,7 @@ Command line arguments .. _supported_record_delimiters: -Supported record delimiters +Supported Record Delimiters ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The supported record delimiters are printable ASCII values (32-126). @@ -409,10 +409,10 @@ The supported record delimiters are printable ASCII values (32-126). * The following characters are **not supported**: ``\``, ``N``, ``-``, ``:``, ``"``, ``\n``, ``\r``, ``.``, lower-case latin letters, digits (0-9) -Meta-commands +Meta-Commands ---------------- -* Meta-commands in SQream SQL start with a backslash (``\``) +* Meta-commands in Sqream SQL start with a backslash (``\``) .. note:: Meta commands do not end with a semicolon @@ -439,7 +439,7 @@ Basic Commands ----------------------- .. list-table:: - :widths: auto + :widths: 20 30 50 :header-rows: 1 * - Command @@ -455,62 +455,62 @@ Basic Commands -Moving about the command line +Moving Around the Command Line --------------------------------- .. list-table:: - :widths: auto + :widths: 17 83 :header-rows: 1 * - Command - Description * - :kbd:`Ctrl-a` - - go to the start of the command line + - Goes to the beginning of the command line. * - :kbd:`Ctrl-e` - - go to the end of the command line - * - :kbd:`Ctrl-k` - - delete from cursor to the end of the command line + - Goes to the end of the command line. * - :kbd:`Ctrl-u` - - delete from cursor to the start of the command line + - Deletes from cursor to the beginning of the command line. + * - :kbd:`Ctrl-k` + - Deletes from the cursor to the end of the command line. * - :kbd:`Ctrl-w` - - delete from cursor to start of word (i.e. delete backwards one word) + - Delete from cursor to beginning of a word. * - :kbd:`Ctrl-y` - - paste word or text that was cut using one of the deletion shortcuts (such as the one above) after the cursor + - Pastes a word or text that was cut using one of the deletion shortcuts (such as the one above) after the cursor. * - :kbd:`Alt-b` - - move backward one word (or go to start of word the cursor is currently on) + - Moves back one word (or goes to the beginning of the word where the cursor is). * - :kbd:`Alt-f` - - move forward one word (or go to end of word the cursor is currently on) + - Moves forward one word (or goes to the end of word the cursor is). * - :kbd:`Alt-d` - - delete to end of word starting at cursor (whole word if cursor is at the beginning of word) + - Deletes to the end of a word starting at the cursor. Deletes the whole word if the cursor is at the beginning of that word. * - :kbd:`Alt-c` - - capitalize to end of word starting at cursor (whole word if cursor is at the beginning of word) + - Capitalizes letters in a word starting at the cursor. Capitalizes the whole word if the cursor is at the beginning of that word. * - :kbd:`Alt-u` - - make uppercase from cursor to end of word + - Capitalizes from the cursor to the end of the word. * - :kbd:`Alt-l` - - make lowercase from cursor to end of word + - Makes lowercase from the cursor to the end of the word. * - :kbd:`Ctrl-f` - - move forward one character + - Moves forward one character. * - :kbd:`Ctrl-b` - - move backward one character + - Moves backward one character. * - :kbd:`Ctrl-h` - - delete character before the cursor + - Deletes characters located before the cursor. * - :kbd:`Ctrl-t` - - swap character under cursor with the previous one + - Swaps a character at the cursor with the previous character. Searching ------------ .. list-table:: - :widths: auto + :widths: 17 83 :header-rows: 1 * - Command - Description * - :kbd:`Ctrl-r` - - search the history backwards + - Searches the history backward. * - :kbd:`Ctrl-g` - - escape from history searching mode + - Escapes from history-searching mode. * - :kbd:`Ctrl-p` - - previous command in history (i.e. walk back through the command history) + - Searches the previous command in history. * - :kbd:`Ctrl-n` - - next command in history (i.e. walk forward through the command history) + - Searches the next command in history. \ No newline at end of file From 8a2ec3ed6d7120726edb132aefc662798ea548b5 Mon Sep 17 00:00:00 2001 From: Yaniv Gerowitz Date: Sun, 13 Jun 2021 10:28:46 +0300 Subject: [PATCH 3/3] Updated links Needs to be merged with Master. Do not merge until Irina responds to your email from 6/10/2021: Regarding points 1 and 2, are you saying to remove all connectors except for the following? * JDBC 4.3.4 * NodeJS 4.2.4 .* Net * C++ * ODBC (Linux and Windows) - 4.1.1 --- guides/client_drivers/index.rst | 37 ++++++++++--------- .../odbc/install_configure_odbc_linux.rst | 14 +++---- .../odbc/install_configure_odbc_windows.rst | 8 ++-- 3 files changed, 30 insertions(+), 29 deletions(-) diff --git a/guides/client_drivers/index.rst b/guides/client_drivers/index.rst index d1a52601b..284b95731 100644 --- a/guides/client_drivers/index.rst +++ b/guides/client_drivers/index.rst @@ -54,7 +54,9 @@ The following are applicable to Windows: * **JDBC installer** - `SQream_JDBC_Driver_v2020.2.0.exe `_ - Windows installer for JDBC driver, with Tableau connector. -* **ODBC installer** - SQream Drivers v2020.2.0 - with Tableau customizations. Please contact your `Sqream represenative `_ for this installer. + :: + +* **ODBC installer** - SQream Drivers v2020.2.0, with Tableau customizations. Please contact your `Sqream represenative `_ for this installer. For more information on installing and configuring ODBC on Windows, see :ref:`Install and configure ODBC on Windows `. @@ -68,25 +70,24 @@ Linux -------------- The following are applicable to Linux: -* - **SQream SQL** (x86_64) - `sqream-sql-v2020.1.1_stable.x86_64.tar.gz `_ - - :ref:`sqream sql` - Interactive command-line SQL client for Intel-based machines - -* - **SQream SQL** (IBM POWER9) - `sqream-sql-v2020.1.1_stable.ppc64le.tar.gz `_ - - :ref:`sqream sql` - Interactive command-line SQL client for IBM POWER9-based machines - -* - **ODBC installer** - ``sqream_odbc_4.0.0_x86_64_linux.tar.gz`` - - :ref:`Linux installer for ODBC`. Please contact your SQream representative to get this installer. +* `SQream SQL (x86_64) `_ - sqream-sql-v2020.1.1_stable.x86_64.tar.gz +* `Sqream SQL CLI Reference `_ - Interactive command-line SQL client for Intel-based machines -* - **C++ connector** - `libsqream-4.1 `_ + :: + +* `SQream SQL*(IBM POWER9) `_ - sqream-sql-v2020.1.1_stable.ppc64le.tar.gz +* `Sqream SQL CLI Reference `_ - Interactive command-line SQL client for IBM POWER9-based machines - :ref:`C++ shared object` library + :: + +* `ODBC Installer `_ - sqream_odbc_4.0.0_x86_64_linux.tar.gz +* :ref:`Linux installer for ODBC`. Please contact your SQream representative for this installer. + + :: + + +* C++ connector - `libsqream-4.0 `_ +* `C++ shared object library `_ .. toctree:: diff --git a/guides/client_drivers/odbc/install_configure_odbc_linux.rst b/guides/client_drivers/odbc/install_configure_odbc_linux.rst index 61919f161..8195c72b2 100644 --- a/guides/client_drivers/odbc/install_configure_odbc_linux.rst +++ b/guides/client_drivers/odbc/install_configure_odbc_linux.rst @@ -1,7 +1,7 @@ .. _install_odbc_linux: **************************************** -Install and configure ODBC on Linux +Installing and Configuring ODBC on Linux **************************************** .. toctree:: @@ -48,14 +48,14 @@ Take note of the location of ``.odbc.ini`` and ``.odbcinst.ini``. In this case, :local: :depth: 1 -Install unixODBC on RHEL 7 / CentOS 7 +Installing unixODBC on RHEL 7 / CentOS 7 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: console $ yum install -y unixODBC unixODBC-devel -Install unixODBC on Ubuntu +Installing unixODBC on Ubuntu ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: console @@ -63,7 +63,7 @@ Install unixODBC on Ubuntu $ sudo apt-get install unixodbc unixodbc-dev -Install the ODBC driver with a script +Installing the ODBC driver with a Script ======================================= Use this method if you have never used ODBC on your machine before. If you have existing DSNs, see the manual install process below. @@ -87,7 +87,7 @@ Use this method if you have never used ODBC on your machine before. If you have #. Edit the DSN created by editing ``/etc/.odbc.ini``. See the parameter explanation in the section :ref:`ODBC DSN Parameters `. -Install the ODBC driver manually +Installing the ODBC Driver Manually ======================================= Use this method when you have existing ODBC DSNs on your machine. @@ -163,7 +163,7 @@ Use this method when you have existing ODBC DSNs on your machine. ODBCInstLib=libodbcinst.so -Install the driver dependencies +Installing the Driver Dependencies ================================== Add the ODBC driver path to ``LD_LIBRARY_PATH``: @@ -174,7 +174,7 @@ Add the ODBC driver path to ``LD_LIBRARY_PATH``: You can also add this previous command line to your ``~/.bashrc`` file in order to keep this installation working between reboots without re-entering the command manually -Testing the connection +Testing the Connection ======================== Test the driver using ``isql``. diff --git a/guides/client_drivers/odbc/install_configure_odbc_windows.rst b/guides/client_drivers/odbc/install_configure_odbc_windows.rst index ee51dc5c9..85c27e8f7 100644 --- a/guides/client_drivers/odbc/install_configure_odbc_windows.rst +++ b/guides/client_drivers/odbc/install_configure_odbc_windows.rst @@ -1,7 +1,7 @@ .. _install_odbc_windows: **************************************** -Install and configure ODBC on Windows +Installing and Configuring ODBC on Windows **************************************** The ODBC driver for Windows is provided as a self-contained installer. @@ -12,7 +12,7 @@ This tutorial shows you how to install and configure ODBC on Windows. :local: :depth: 2 -Installing the ODBC driver +Installing the ODBC Driver ================================== Prerequisites @@ -28,7 +28,7 @@ The ODBC driver requires Microsoft's Visual Studio 2015 Redistributable packages Follow the instructions for download and installation on Microsoft's website https://www.microsoft.com/en-us/download/details.aspx?id=48145 -Administrator privileges +Administrator Privileges ^^^^^^^^^^^^^^^^^^^^^^^^^^^ The SQream DB ODBC driver requires administrator privileges on your computer to add the DSNs (data source names). @@ -87,7 +87,7 @@ ODBC driver configurations are done via DSNs. Each DSN represents one SQream DB -Connection parameters +Connection Parameters ----------------------- .. list-table::