Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 67 additions & 56 deletions guides/client_drivers/index.rst
Original file line number Diff line number Diff line change
@@ -1,94 +1,105 @@
.. _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 are applicable to all operating systems:

*
**JDBC** - `sqream-jdbc v4.3.3 (.jar) <http://downloads.sqream.com/drivers/2020.3/sqream-jdbc-4.3.3.jar>`_

:ref:`java_jdbc` Driver

(SQream recommends installing via ``mvn``)
.. _jdbc:

* **JDBC** - recommended installation via ``mvn``:

* `JDBC .jar file <https://sq-ftp-public.s3.amazonaws.com/sqream-jdbc-4.4.0.jar>`_ - sqream-jdbc-4.4.0 (.jar)
* `JDBC driver <https://docs.sqream.com/en/latest/guides/client_drivers/jdbc/index.html#java-jdbc>`_


.. _python:

* **Python** - Recommended installation via ``pip``:

* `Python .tar file <https://github.com/SQream/pysqream/releases/tag/v3.1.3>`_ - pysqream v3.1.3 (.tar.gz)
* `Python driver <https://docs.sqream.com/en/latest/guides/client_drivers/python/index.html#pysqream>`_


.. _nodejs:

* **Node.JS** - Recommended installation via ``npm``:

* `Node.JS <https://sq-ftp-public.s3.amazonaws.com/sqream-sqreamdb-4.2.4.tgz>`_ - sqream-v4.2.4 (.tar.gz)
* `Node.JS driver <https://docs.sqream.com/en/latest/guides/client_drivers/nodejs/index.html#nodejs>`_


.. _tableau_connector:

* **Tableau**:

* `Tableau connector <http://downloads.sqream.com/drivers/2020.3/SQreamDB.taco>`_ - SQreamDB (.taco)
* `Tableau manual installation <https://docs.sqream.com/en/latest/guides/third_party_tools/tableau.html#tableau-manual-installation>`_

*
**Python** - `pysqream v3.1.3 (.tar.gz) <https://github.com/SQream/pysqream/releases/tag/v3.1.3>`_

:ref:`pysqream` - Python driver

(SQream recommends installing via ``pip``)

*
**Node.JS** - `sqream-v4.2.4 (.tar.gz) <http://downloads.sqream.com/drivers/2020.3/sqream-sqreamdb-4.2.4.tgz>`_

:ref:`nodejs` - Node.JS driver

(SQream recommends installing via ``npm``)

*
**Tableau Connector** - `SQreamDB (.taco) <http://downloads.sqream.com/drivers/2020.3/SQreamDB.taco>`_

:ref:`Tableau connector<tableau_manual_installation>` - Tableau connector for manual installation

Windows
--------------
The following are applicable to Windows:

*
**JDBC installer** - `SQream_JDBC_Driver_v2020.2.0.exe <http://downloads.sqream.com/drivers/2020.3/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<install_odbc_windows>`, with Tableau customizations. Please contact your SQream representative to get this installer.
* **JDBC installer** - `SQream_JDBC_Driver_v2020.2.0.exe <http://downloads.sqream.com/drivers/2020.3/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 <https://sqream.atlassian.net/servicedesk/customer/portal/2>`_ for this installer.

* **.Net driver** - `SQream .Net driver v2.0.0 <http://downloads.sqream.com/drivers/2020.2/sqream_dotnet-2.0.0.zip>`_
For more information on installing and configuring ODBC on Windows, see :ref:`Install and configure ODBC on Windows <install_odbc_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 <http://downloads.sqream.com/drivers/2020.2/SqreamNet_net48_3.0.2.dll>`_



Linux
--------------
The following are applicable to Linux:

*
**SQream SQL** (x86) - `sqream-sql-v2020.1.1_stable.x86_64.tar.gz <http://downloads.sqream.com/drivers/2020.2/sqream-sql-v2020.1.1_stable.x86_64.tar.gz>`_

:ref:`sqream sql<sqream_sql_cli_reference>` - Interactive command-line SQL client for Intel-based machines

*
**SQream SQL** (IBM POWER9) - `sqream-sql-v2020.1.1_stable.ppc64le.tar.gz <http://downloads.sqream.com/drivers/2020.2/sqream-sql-v2020.1.1_stable.ppc64le.tar.gz>`_

:ref:`sqream sql<sqream_sql_cli_reference>` - 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<install_odbc_linux>`. Please contact your SQream representative to get this installer.
* `SQream SQL (x86_64) <https://sq-ftp-public.s3.amazonaws.com/sqream-sql-v2020.1.1_stable.x86_64.tar.gz>`_ - sqream-sql-v2020.1.1_stable.x86_64.tar.gz
* `Sqream SQL CLI Reference <https://docs.sqream.com/en/latest/reference/cli/sqream_sql.html#sqream-sql-cli-reference>`_ - Interactive command-line SQL client for Intel-based machines

::

*
**C++ connector** - `libsqream-4.0 <http://downloads.sqream.com/drivers/2020.2/libsqream-4.0.tar.gz>`_
* `SQream SQL*(IBM POWER9) <https://sq-ftp-public.s3.amazonaws.com/sqream-sql-v2020.1.1_stable.ppc64le.tar.gz>`_ - sqream-sql-v2020.1.1_stable.ppc64le.tar.gz
* `Sqream SQL CLI Reference <https://docs.sqream.com/en/latest/reference/cli/sqream_sql.html#sqream-sql-cli-reference>`_ - Interactive command-line SQL client for IBM POWER9-based machines

:ref:`C++ shared object<cpp_native>` library
::

* `ODBC Installer <https://sq-ftp-public.s3.amazonaws.com/sqream-sql-v2020.1.1_stable.ppc64le.tar.gz>`_ - sqream_odbc_4.0.0_x86_64_linux.tar.gz
* :ref:`Linux installer for ODBC<install_odbc_linux>`. Please contact your SQream representative for this installer.

::


* C++ connector - `libsqream-4.0 <https://sq-ftp-public.s3.amazonaws.com/libsqream-4.0.tar.gz>`_
* `C++ shared object library <https://docs.sqream.com/en/latest/guides/client_drivers/cpp/index.html#getting-the-library>`_


.. toctree::
:maxdepth: 4
:caption: Client driver documentation:
:caption: Client Driver Documentation:
:titlesonly:

python/index
cpp/index
jdbc/index
odbc/index
python/index
nodejs/index
odbc/index
cpp/index



Expand Down
14 changes: 7 additions & 7 deletions guides/client_drivers/odbc/install_configure_odbc_linux.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _install_odbc_linux:

****************************************
Install and configure ODBC on Linux
Installing and Configuring ODBC on Linux
****************************************

.. toctree::
Expand Down Expand Up @@ -48,22 +48,22 @@ 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

$ 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.
Expand All @@ -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 <dsn_params>`.


Install the ODBC driver manually
Installing the ODBC Driver Manually
=======================================

Use this method when you have existing ODBC DSNs on your machine.
Expand Down Expand Up @@ -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``:
Expand All @@ -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``.
Expand Down
8 changes: 4 additions & 4 deletions guides/client_drivers/odbc/install_configure_odbc_windows.rst
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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
Expand All @@ -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).
Expand Down Expand Up @@ -87,7 +87,7 @@ ODBC driver configurations are done via DSNs. Each DSN represents one SQream DB



Connection parameters
Connection Parameters
-----------------------

.. list-table::
Expand Down
10 changes: 5 additions & 5 deletions reference/cli/index.rst
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -17,7 +17,7 @@ This topic contains the reference for these programs, as well as flags and confi
* - :ref:`sqream sql<sqream_sql_cli_reference>`
- Built-in SQL client

.. list-table:: SQream DB cluster components
.. list-table:: SQream DB Cluster Components
:widths: auto
:header-rows: 1

Expand All @@ -30,7 +30,7 @@ This topic contains the reference for these programs, as well as flags and confi
* - :ref:`server_picker <server_picker_cli_reference>`
- Load balancer end-point

.. list-table:: SQream DB utilities
.. list-table:: Sqream DB Utilities
:widths: auto
:header-rows: 1

Expand All @@ -41,7 +41,7 @@ This topic contains the reference for these programs, as well as flags and confi
* - :ref:`upgrade_storage <upgrade_storage_cli_reference>`
- Upgrade metadata schemas when upgrading between major versions

.. list-table:: Docker utilities
.. list-table:: Docker Utilities
:widths: auto
:header-rows: 1

Expand Down
Loading