You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@drill.apache.org by br...@apache.org on 2017/05/30 23:14:53 UTC
[2/2] drill git commit: Updated docs from Catherine Skrbina for
latest ODBC driver
Updated docs from Catherine Skrbina for latest ODBC driver
Project: http://git-wip-us.apache.org/repos/asf/drill/repo
Commit: http://git-wip-us.apache.org/repos/asf/drill/commit/ee71b646
Tree: http://git-wip-us.apache.org/repos/asf/drill/tree/ee71b646
Diff: http://git-wip-us.apache.org/repos/asf/drill/diff/ee71b646
Branch: refs/heads/gh-pages
Commit: ee71b646e87ef1c297be08b79e9955775d0ab6ef
Parents: e8bbb9d
Author: Bridget Bevens <bb...@maprtech.com>
Authored: Tue May 30 16:11:45 2017 -0700
Committer: Bridget Bevens <bb...@maprtech.com>
Committed: Tue May 30 16:11:45 2017 -0700
----------------------------------------------------------------------
_docs/img/odbc-configure1.png | Bin 43220 -> 65848 bytes
_docs/img/odbc-configure2.png | Bin 56060 -> 93811 bytes
_docs/img/odbc-drivers.png | Bin 49123 -> 21466 bytes
_docs/img/odbc-explorer-connect.png | Bin 10233 -> 4738 bytes
_docs/img/odbc-explorer-win.png | Bin 24127 -> 24696 bytes
_docs/img/odbc-user-dsn.png | Bin 36866 -> 19725 bytes
_docs/img/winsettings.png | Bin 0 -> 65849 bytes
_docs/img/winstart.png | Bin 0 -> 53392 bytes
.../010-odbc-configuration-reference.md | 121 +++++++-----
.../020-configuring-odbc-on-linux.md | 132 ++++++++-----
.../025-configuring-odbc-on-mac-os-x.md | 82 +++++---
.../030-configuring-odbc-on-windows.md | 31 +--
.../040-testing-the-odbc-connection.md | 187 +++++++++++++++----
.../010-installing-the-driver-on-linux.md | 39 ++--
.../020-installing-the-driver-on-mac-os-x.md | 20 +-
.../030-installing-the-driver-on-windows.md | 38 ++--
.../020-connecting-drill-explorer-to-data.md | 38 ++--
17 files changed, 449 insertions(+), 239 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/drill/blob/ee71b646/_docs/img/odbc-configure1.png
----------------------------------------------------------------------
diff --git a/_docs/img/odbc-configure1.png b/_docs/img/odbc-configure1.png
index 28717bd..26e6d39 100755
Binary files a/_docs/img/odbc-configure1.png and b/_docs/img/odbc-configure1.png differ
http://git-wip-us.apache.org/repos/asf/drill/blob/ee71b646/_docs/img/odbc-configure2.png
----------------------------------------------------------------------
diff --git a/_docs/img/odbc-configure2.png b/_docs/img/odbc-configure2.png
index af79337..e1774c6 100755
Binary files a/_docs/img/odbc-configure2.png and b/_docs/img/odbc-configure2.png differ
http://git-wip-us.apache.org/repos/asf/drill/blob/ee71b646/_docs/img/odbc-drivers.png
----------------------------------------------------------------------
diff --git a/_docs/img/odbc-drivers.png b/_docs/img/odbc-drivers.png
index 23b9c39..1578c2b 100755
Binary files a/_docs/img/odbc-drivers.png and b/_docs/img/odbc-drivers.png differ
http://git-wip-us.apache.org/repos/asf/drill/blob/ee71b646/_docs/img/odbc-explorer-connect.png
----------------------------------------------------------------------
diff --git a/_docs/img/odbc-explorer-connect.png b/_docs/img/odbc-explorer-connect.png
index 960e963..d07bbd5 100644
Binary files a/_docs/img/odbc-explorer-connect.png and b/_docs/img/odbc-explorer-connect.png differ
http://git-wip-us.apache.org/repos/asf/drill/blob/ee71b646/_docs/img/odbc-explorer-win.png
----------------------------------------------------------------------
diff --git a/_docs/img/odbc-explorer-win.png b/_docs/img/odbc-explorer-win.png
index 04bda8a..ae2d06b 100644
Binary files a/_docs/img/odbc-explorer-win.png and b/_docs/img/odbc-explorer-win.png differ
http://git-wip-us.apache.org/repos/asf/drill/blob/ee71b646/_docs/img/odbc-user-dsn.png
----------------------------------------------------------------------
diff --git a/_docs/img/odbc-user-dsn.png b/_docs/img/odbc-user-dsn.png
index f957607..1290a2d 100755
Binary files a/_docs/img/odbc-user-dsn.png and b/_docs/img/odbc-user-dsn.png differ
http://git-wip-us.apache.org/repos/asf/drill/blob/ee71b646/_docs/img/winsettings.png
----------------------------------------------------------------------
diff --git a/_docs/img/winsettings.png b/_docs/img/winsettings.png
new file mode 100644
index 0000000..39be084
Binary files /dev/null and b/_docs/img/winsettings.png differ
http://git-wip-us.apache.org/repos/asf/drill/blob/ee71b646/_docs/img/winstart.png
----------------------------------------------------------------------
diff --git a/_docs/img/winstart.png b/_docs/img/winstart.png
new file mode 100644
index 0000000..14f9361
Binary files /dev/null and b/_docs/img/winstart.png differ
http://git-wip-us.apache.org/repos/asf/drill/blob/ee71b646/_docs/odbc-jdbc-interfaces/configuring-odbc/010-odbc-configuration-reference.md
----------------------------------------------------------------------
diff --git a/_docs/odbc-jdbc-interfaces/configuring-odbc/010-odbc-configuration-reference.md b/_docs/odbc-jdbc-interfaces/configuring-odbc/010-odbc-configuration-reference.md
index c7e2f32..9018f66 100644
--- a/_docs/odbc-jdbc-interfaces/configuring-odbc/010-odbc-configuration-reference.md
+++ b/_docs/odbc-jdbc-interfaces/configuring-odbc/010-odbc-configuration-reference.md
@@ -1,9 +1,8 @@
---
title: "ODBC Configuration Reference"
-date: 2016-12-24 00:32:37 UTC
+date: 2017-05-30 23:11:51 UTC
parent: "Configuring ODBC"
---
-
You can use various configuration options to control the behavior of the MapR
Drill ODBC Driver. You can use these options in a connection string or in the
`odbc.ini` configuration file for the Mac OS X version or the driver.
@@ -14,27 +13,32 @@ Drill ODBC Driver. You can use these options in a connection string or in the
The following table provides a list of the configuration options and a brief description. Subsequent sections describe options in more detail:
-| Property | Valid Values | Brief Description |
-|--------------------|---------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Catalog | DRILL | The name of the synthetic catalog under which all of the schemas/databases are organized. |
-| ConnectionType | Direct or ZooKeeper | Direct connects to a Drill server using Host and Port properties. ZooKeeper connects to a ZooKeeper cluster using ZKQuorum and ZKClusterID properties. |
-| Driver | MapR Drill ODBC Driver | The name of the installed driver. |
-| Host | `<host name>` | If the ConnectionType property is set to Direct, set the host name of the Drill server using the Host property. |
-| Port | 31010 | If the ConnectionType property is set to Direct, set the e TCP port on which the Drill server is listening. |
-| Schema | `<schema name>` | The name of the database schema or storage plugin name to use when the query does not explicitly specify the schema or storage plugin. |
-| ZKClusterID | drillbits1 | If the ConnectionType property is set to ZooKeeper, then set ZKClusterID to the name of the Drillbit cluster to use. |
-| ZKQuorum | `<IP address>`,`<IP address>` . . . | If the ConnectionType property is set to ZooKeeper, then use ZKQuorum to indicate the server(s) in your ZooKeeper cluster. Separate multiple servers using a comma (,). |
-| AuthenticationType | No Authentication or Basic Authentication | Basic Authentication [enables impersonation](https://drill.apache.org/docs/configuring-user-impersonation/). |
-| UID | `<user name>` | If AuthenticationType is Basic Authentication, set the UID to a user name. |
-| PWD | `<password>` | If AuthenticationType is Basic Authentication, set the PWD to a password. |
-| DelegationUID | `<impersonation_target>` | The impersonation target for the authorized proxy user. See [Configuring Inbound Impersonation](https://drill.apache.org/docs/configuring-inbound-impersonation/). |
-| AdvancedProperties | {`<property>`;`<property>`; . . .} | Separate advanced properties using a semi-colon (;) and then surround all advanced properties in a connection string using braces { and }. |
-| DisableAsync | 0 or 1 | Disables asynchronous ODBC connection and enables a synchronous connection. A change in state occurs during driver initialization and is propagated to all driver DSNs. |
+| Property | Default Values | Brief Description |
+|-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| AdvancedProperties | CastAnyToVarchar=true; HandshakeTimeout=5; QueryTimeout=180;TimestampTZDisplayTimezone=local; ExcludedSchemas=sys,INFORMATION_SCHEMA; NumberOfPrefetchBuffers=5 | Not required. Advanced properties for configuring the driver. You can set custom connection properties by specifying them as advanced properties. If you specify a property that the driver does not explicitly support, the driver still accepts the property, and passes it to the server for processing. Separate advanced properties using a semi-colon (;) and then surround all advanced properties in a connection string using braces { and }. For example, {<property>;<property>; . . .} In addition, the following Advanced Properties string excludes the schemas named test and abc, sets the timeout to 30 seconds, and sets the time zone to Coordinated Universal Time: HandshakeTimeout=30;QueryTimeout=30;TimestampTZDisplayTimezone=utc;ExcludedSchemas=test,abc |
+| AuthenticationType | No Authentication | Not required. This option specifies how the driver authenticates the connection to Drill. No Authentication: The driver does not authenticate the connection to Drill. Kerberos: The driver authenticates the connection using the Kerberos protocol. Plain: The driver authenticates the connection using a user name and apassword. MapRSASL: The driver authenticates the connection using the MapR-SASL protocol. |
+| Catalog | The default catalog name specified in the driver's .did file (typically, DRILL). | Not required. The name of the synthetic catalog under which all of the schemas/databases are organized. This catalog name is used as the value for SQL_DATABASE_NAME or CURRENT CATALOG. |
+| ConnectionType | Direct to Drillbit (Direct) | Required. This option specifies whether the driver connects to a single server or a ZooKeeper cluster. Direct to Drillbit (Direct): The driver connects to a single Drill server. ZooKeeper Quorum (ZooKeeper): The driver connects to a ZooKeeper cluster. |
+| DelegationUID | none | Not required. If a value is specified for this setting, the driver delegates all operations against Drill to the specified user, rather than to the authenticated user for the connection. This option is applicable only when Plain authentication is enabled. |
+| DisableAsync | Clear (0) | Not required. This option specifies whether the driver supports asynchronous queries. Enabled (1): The driver does not support asynchronous queries. Disabled (0): The driver supports asynchronous queries. This option is not supported in connection strings or DSNs. Instead, it must be set as a driver-wide property in the mapr.drillodbc.ini file. Settings in that file apply to all connections that use the driver. |
+| Driver | MapR Drill ODBC Driver on Windows machines or the absolute path of the driver shared object file when installed on a non-Windows machine | On Windows, the name of the installed driver (MapR Drill ODBC Driver). On other platforms, the name of the installed driver as specified in odbcinst.ini, or the absolute path of the driver shared object file. |
+| Host | localhost | Required if the ConnectionType property is set to Direct to Drillbit. The IP address or host name of the Drill server. |
+| KrbServiceHost | none | Required for Kerberos authentication. The fully qualified domain name of the Drill server host. |
+| KrbServiceName | mapr (default) | Required for Kerberos authentication. The Kerberos service principal name of the Drill server. mapr is the default for the MapR Drill ODBC driver. |
+| LogLevel | OFF (0) | Not required. Use this property to enable or disable logging in the driver and to specify the amount of detail included in log files. Only enable logging long enough to capture an issue. Logging decreases performance and can consume a large quantity of disk space. This option is not supported in connection strings. To configure logging for the Windows driver, you must use the Logging Options dialog box. To configure logging for a non-Windows driver, you must use the mapr.drillodbc.ini file. |
+| LogPath | none | Required if logging is enabled. The full path to the folder where the driver saves log files when logging is enabled. When logging is enabled, the driver produces two log files at the location that youspecify in the LogPath property: driver.log provides a log of driver activities, and drillclient.log provides a log of Drill client activities. This option is not supported in connection strings. To configure logging for the Windows driver, you must use the Logging Options dialog box. To configure logging for a non-Windows driver, you must use the mapr.drillodbc.ini file. |
+| Port | 31010 | Required if the ConnectionType property is set to Direct to Drillbit. The TCP port that the Drill server uses to listen for client connections. Set the TCP port on which the Drill server is listening. |
+| PWD | none | Required if AuthenticationType is Plain (also known as Basic Authentication). The password corresponding to the user name that you provided in the User field (the UID key). |
+| Schema | none | Not required. The name of the database schema to use when a schema is not explicitly specified in a query. You can still issue queries on other schemas by explicitly specifying the schema in the query. |
+| UID | none | Required if AuthenticationType is Plain (also known as Basic authentication). Set UID to a user name. |
+| UseOnlySSPI (on Windows only) | Clear (0) | Not required. This option is available only in the Windows driver. This option specifies how the driver handles Kerberos authentication: either with theSSPI plugin or with MIT Kerberos. Enabled (1): The driver handles Kerberos authentication by using the SSPI plugin instead of MIT Kerberos by default. Disabled (0): The driver uses MIT Kerberos to handle Kerberos authentication, and only uses the SSPI plugin if the GSSAPI library is not available. |
+| ZKClusterID | drillbits1 | Required if the ConnectionType property is set to ZooKeeper Quorum. Set ZKClusterID to the name of the Drillbit cluster to use. |
+| ZKQuorum | none | Required if the ConnectionType property is set to ZooKeeper. Set ZKQuorum to indicate the server(s) in your ZooKeeper cluster. Separate multiple servers using a comma (,). For example, <IP address>,<IP address>. |
|
### Catalog
-This value defaults to DRILL and cannot be changed. The driver adds a synthetic catalog named DRILL under which all of the schemas and databases are organized. The driver maps the ODBC schema to the DRILL catalog.
+This value defaults to DRILL and should not be changed. The driver adds a synthetic catalog named DRILL under which all of the schemas and databases are organized. The driver maps the ODBC schema to the DRILL catalog.
### Connection Type
@@ -112,26 +116,35 @@ TimestampTZDisplayTimezone=utc;ExcludedSchemas=test,abc`
The following table lists and describes the advanced properties that you can
set when using the MapR Drill ODBC Driver.
-| Property Name | Default Value | Description |
-|----------------------------|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| HandshakeTimeout | 5 | An integer value representing the number of seconds that the driver waits before aborting an attempt to connect to a data source. When set to a value of 0, the driver does not abort connection attempts. |
-| QueryTimeout | 180 | An integer value representing the number of seconds for the driver to wait before automatically stopping a query. When set to a value of 0, the driver does not stop queries automatically. |
-| TimestampTZDisplayTimezone | local | Two values are possible: local—Timestamps are dependent on the time zone of the user. utc—Timestamps appear in Coordinated Universal Time (UTC). |
-| ExcludedSchemas | sys, INFORMATION_SCHEMA | The value of ExcludedSchemas is a list of schemas that do not appear in client applications such as Drill Explorer, Tableau, and Excel. Separate schemas in the list using a comma (,). |
-| CastAnyToVarchar | true | Casts the ANY data type returned from SQL column calls into type “VARCHAR”. |
-| NumberOfPrefetchBuffers | 5 | The size of the record batch queue in the driver. When set to a value below 1, the value defaults to 1. |
+| Property | Default Values | Brief Description |
+|----------------------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| CastAnyToVarchar | TRUE | Not required. When this property is set to true, if SQLColumns returns columns of type ANY, then the driver casts the columns to VARCHAR. When this property is set to false, the driver does not change the returned columns. |
+| ConvertToCast | FALSE | Not required. When activated this enables the Cast Query Translation function. This function helps optimize your queries for Power BI. |
+| DefaultDecimalScale | 10 | The default scale for DECIMAL columns that are returned through SQLColumns. The driver uses this value only if SQLColumns does not return a scale value or a numeric precision value that the driver can use to determine the scale. |
+| ExcludedSchemas | sys,INFORMATION_SCHEMA | Not required. A list of schemas that do not appear in client applications such as Drill Explorer, Tableau, and Excel. Separate schemas in the list using a comma (,).This property should not be used at the same time as IncludedSchemas. If both IncludedSchemas and ExcludedSchemas are specified, IncludedSchemas takes precedence and ExcludedSchemas is ignored. |
+| GetMetadataWithQueries | None | Not required. This property specifies whether the driver uses queries or native API calls when retrieving metadata, preparing statements, or executing statements. The driver can only use native API calls if it detects that the server is running a version of Drill that supports those calls. If this property is set to True, the driver uses queries to retrieve metadata,prepare statements, and execute statements. l If this property is set to False, the driver instead uses native API calls when it is connected to a server that supports native API calls. |
+| HandshakeTimeout | 5 | Not required. An integer value representing the number of seconds that the driver waits before stopping an attempt to connect to a data source. If this property is set to 0, the driver does not stop connection attempts. |
+| HeartBeatFreqSec | 15 | Not required. The number of seconds of inactivity before the Drill client sends a heartbeat to the server in order to check the status of the connection. If this property is set to 0, the Drill client does not send any heartbeats. |
+| IncludedSchemas | None | Not required. A list of schemas that appear in client applications such as Drill Explorer, Tableau, and Excel. Separate schemas in the list using a comma (,). If this option is set, then schemas that are not in this list are not queried by the driver. |
+| NonZeroNameMaxLen | FALSE | Not required. The MapR Drill ODBC Driver does not enforce a maximum length for schema, catalog, table, and column names. By default, the driver reports these lengths as 0, which typically indicates that there is no maximum length. However, some BI tools interpret a length of 0 literally. To make sure that the names are displayed correctly in your BI tool,set the NonZeroNameMaxLen property. When this property is set to true, the driver reports an appropriate non-zero value for the maximum length of schema, catalog, table, and column names. When this property is set to false, the driver reports 0 as the maximum length of schema, catalog, table, and column names. |
+| NumberOfPrefetchBuffers | 5 | Not required. The size of the record batch queue in the driver. When set to a value below 1, the value defaults to 1. |
+| QueryTimeout | 180 | Not required. The number of seconds that the driver waits before stopping a query. If this property is set to 0, the driver does not stop queries. |
+| RemoveQryCatalog | TRUE | Not required. When this property is set to true, the driver removes catalog names from queries. Enable this option if you are working with a server that does not accept queries containing catalog names. When this property is set to false, the driver does not remove catalog names before executing queries. |
+| SaslPluginDir | None | Not required. Allows you to override the default SASL plugin directory with a custom directory path. |
+| StringColumnLength | 1024 | Not required. The maximum column length that the driver reports for string columns. |
+| TimestampTZDisplayTimezone | local | Not required. Two values are possible: local and utc. When set to local, timestamps use the time zone of the user. When set to utc, timestamps appear in Coordinated Universal Time (UTC). |
### Connection String Examples
If you want to connect to a Drill data source from an application that does
not require a DSN, you can use an ODBC connection string. The following is an example connection string for the Direct connection type:
- DRIVER=MapR Drill ODBC Driver;AdvancedProperties={HandshakeTimeout=0;QueryTimeout=0;TimestampTZDisplayTimezone=utc;ExcludedSchemas=sys,INFORMATION_SCHEMA;};Catalog=DRILL;Schema=hivestg;ConnectionType=Direct;Host=192.168.202.147;Port=31010
+ DRIVER=MapR Drill ODBC Driver;AdvancedProperties={HandshakeTimeout=0;QueryTimeout=0;TimestampTZDisplayTimezone=utc;ExcludedSchemas=sys,INFORMATION_SCHEMA;};Catalog=DRILL;Schema=hivestg;ConnectionType=Direct;Host=192.168.202.147;Port=31010
The following is an example connection string for the Zookeeper connection
type:
- DRIVER=MapR Drill ODBC Driver;AdvancedProperties={HandshakeTimeout=0;QueryTimeout=0;TimestampTZDisplayTimezone=utc;ExcludedSchemas=sys, INFORMATION_SCHEMA;};Catalog=DRILL;Schema=;ConnectionType=ZooKeeper;ZKQuorum=192.168.39.43:5181;ZKClusterID=drillbits1
+ DRIVER=MapR Drill ODBC Driver;AdvancedProperties={HandshakeTimeout=0;QueryTimeout=0;TimestampTZDisplayTimezone=utc;ExcludedSchemas=sys, INFORMATION_SCHEMA;};Catalog=DRILL;Schema=;ConnectionType=ZooKeeper;ZKQuorum=192.168.39.43:5181;ZKClusterID=drillbits1
## Logging Options
@@ -142,44 +155,50 @@ and a log path.
If logging is enabled, the MapR Drill ODBC driver logs events in following log
files in the log path that you configure:
-* driver.log: A log of driver events
-* drillclient.log: A log of the Drill client events.
+* `driver.log` provides a log of driver events.
+* `drillclient.log` provides a log of the Drill client events.
### Logging Levels
The following log levels are available:
-* OFF: Disables logging.
-* FATAL: Logs severe error events that may cause the driver to stop running.
-* ERROR: Logs error events that may allow the driver to continue running.
-* WARNING: Logs events about potentially harmful situations.
-* INFO: Logs high-level events about driver processes.
-* DEBUG: Logs detailed events that may help to debug issues.
-* TRACE: Logs finer-grained events than the DEBUG level.
+* (0) OFF: Disables logging.
+* (1) FATAL: Logs severe error events that may cause the driver to stop running.
+* (2) ERROR: Logs error events that may allow the driver to continue running.
+* (3) WARNING: Logs events about potentially harmful situations.
+* (4) INFO: Logs high-level events about driver processes.
+* (5) DEBUG: Logs detailed events that may help to debug issues.
+* (6) TRACE: Logs finer-grained events than the DEBUG level.
### Enabling Logging
To enable logging:
-1. Open the mapr.drillodbc.ini configuration file in a text editor.
-2. Set the LogLevel key to the desired level of information to include in log files. For
-example:
-`LogLevel=2`
-3. Set the LogPath key to the full path to the folder where you want to save log files. For example:
-`LogPath=/localhome/employee/Documents`
-4. Save the mapr.drillodbc.ini configuration file.
-The Simba ODBC Driver for Apache Drill produces two log files at the location you specify using the Log Path field:
- * driver.log provides a log of driver activities
- * drillclient.log provides a log of Drill client activities
+1. Open the `.mapr.drillodbc.ini` configuration file in a text editor. (On Mac OS X, the default installation will install a .mapr.drillodbc.ini to $HOME.)
+2. Set the LogLevel key to the desired level of information to include in log files.
+For example:
+
+ `LogLevel=2`
+
+3. Set the LogPath key to the full path to the folder where you want to save log files.
+For example:
+
+ `LogPath=/localhome/employee/Documents`
+
+4. Save the `.mapr.drillodbc.ini` configuration file. The MapR Drill ODBC Driver produces two log files at the location you specify using the Log Path field:
+ * `driver.log` provides a log of driver activities.
+ * `drillclient.log` provides a log of Drill client activities.
### Disabling Logging
To disable logging:
-1. Open the mapr.drillodbc.ini configuration file in a text editor.
-2. Set the LogLevel key to 0
-3. Save the mapr.drillodbc.ini configuration file.
+1. Open the `.mapr.drillodbc.ini` configuration file in a text editor.
+2. Set the LogLevel key to zero (`0`).
+3. Save the `.mapr.drillodbc.ini` configuration file.
#### What's Next? Go to [Connecting to ODBC Data Sources]({{ site.baseurl }}/docs/connecting-to-odbc-data-sources).
+
+
http://git-wip-us.apache.org/repos/asf/drill/blob/ee71b646/_docs/odbc-jdbc-interfaces/configuring-odbc/020-configuring-odbc-on-linux.md
----------------------------------------------------------------------
diff --git a/_docs/odbc-jdbc-interfaces/configuring-odbc/020-configuring-odbc-on-linux.md b/_docs/odbc-jdbc-interfaces/configuring-odbc/020-configuring-odbc-on-linux.md
index b0c5db2..440bb70 100644
--- a/_docs/odbc-jdbc-interfaces/configuring-odbc/020-configuring-odbc-on-linux.md
+++ b/_docs/odbc-jdbc-interfaces/configuring-odbc/020-configuring-odbc-on-linux.md
@@ -1,8 +1,9 @@
---
title: "Configuring ODBC on Linux"
-date: 2016-05-20 17:51:57 UTC
+date: 2017-05-30 23:11:52 UTC
parent: "Configuring ODBC"
---
+
ODBC driver managers use configuration files to define and configure ODBC data
sources and drivers. To configure an ODBC connection for Linux, complete the following
steps:
@@ -15,7 +16,7 @@ steps:
## Sample Configuration Files
Before you connect to Drill through an ODBC client tool
-on Linux, copy the following configuration files in `/opt/mapr/drillodbc/Setup` to your home directory unless the files already exist in your home directory:
+on Linux, copy the following configuration files in `/opt/mapr/drill/Setup` to your home directory unless the files already exist in your home directory:
* `mapr.drillodbc.ini`
* `odbc.ini`
@@ -35,11 +36,11 @@ In your home directory, rename the files as hidden files. Use sudo if necessary:
`export ODBCINI=~/.odbc.ini`
2. Set the MAPRDRILLINI environment variable to point to `.mapr.drillodbc.ini` in your home directory. For example:
`export MAPRDRILLINI=~/.mapr.drillodbc.ini`
-3. Set the LD_LIBRARY_PATH environment variable to point to your ODBC driver manager libraries and the MapR ODBC Driver for Apache Drill shared libraries. For example:
- `export LD_LIBRARY_PATH=/usr/local/lib:/opt/mapr/drillodbc/lib/64`
+3. Set the `LD_LIBRARY_PATH` environment variable to point to your ODBC driver manager libraries. For example:
+ `export LD_LIBRARY_PATH=/usr/local/lib`
You can have both 32- and 64-bit versions of the driver installed at the same time on the same computer.
-{% include startimportant.html %}Do not include the paths to both 32- and 64-bit shared libraries in LD_LIBRARY PATH at the same time.{% include endimportant.html %}
+{% include startimportant.html %}Do not include the paths to both 32- and 64-bit shared libraries in `LD_LIBRARY_PATH` at the same time.{% include endimportant.html %}
Only include the path to the shared libraries corresponding to the driver matching the bitness of the client application you use to access Drill.
----------
@@ -62,51 +63,96 @@ To use Drill in distributed mode, set the following properties, described in det
ZKQuorum=<host name>:<port>,<host name>:<port> . . . <host name>:<port>
ZKClusterID=<cluster name in `drill-override.conf`>
-The following Linux sample shows a possible configuration for using Drill in distributed mode. The configuration assumes you started Drill using the `drill-conf` command. The example modifies the default Linux-installed `.odbc.ini` for a 64-bit system by commenting out 32-bit properties, adding 64-bit properties, and removes the extraneous [Sample MapR Drill DSN 64] from `.odbc.ini`.
+The following Linux sample shows a possible configuration for using Drill in distributed mode. The configuration assumes you started Drill using the `drill-conf` command. The example modifies the default Linux-installed `.odbc.ini` for a 64-bit system by commenting out 32-bit properties, adding 64-bit properties, and removes the extraneous MapR Drill 64-bit from `.odbc.ini`.
[ODBC]
Trace=no
[ODBC Data Sources]
- #Sample MapR Drill DSN 32=MapR Drill ODBC Driver 32-bit
- Sample MapR Drill DSN 64=MapR Drill ODBC Driver 64-bit
-
- [Sample MapR Drill DSN 64]
- #[Sample MapR Drill DSN 32]
+ MapR Drill 32-bit=MapR Drill ODBC Driver 32-bit
+ MapR Drill 64-bit=MapR Drill ODBC Driver 64-bit
+ [MapR Drill 32-bit]
# This key is not necessary and only describes the data source.
- #Description=MapR Drill ODBC Driver (32-bit) DSN
- Description=MapR Drill ODBC Driver (64-bit) DSN
-
+
+ # Description=MapR Drill ODBC Driver (32-bit) DSN
+ Description=MapR Drill ODBC Driver (32-bit) DSN
# Driver: The location where the ODBC driver is installed to.
- #Driver=/opt/mapr/drillodbc/lib/32/libmaprdrillodbc32.so
- Driver=/opt/mapr/drillodbc/lib/64/libmaprdrillodbc64.so
-
+ Driver=/opt/mapr/drill/lib/32/libdrillodbc_sb32.so
+
# The DriverUnicodeEncoding setting is only used for SimbaDM
# When set to 1, SimbaDM runs in UTF-16 mode.
# When set to 2, SimbaDM runs in UTF-8 mode.
- #DriverUnicodeEncoding=2
+ # DriverUnicodeEncoding=2
# Values for ConnectionType, AdvancedProperties, Catalog, Schema should be set here.
# If ConnectionType is Direct, include Host and Port. If ConnectionType is ZooKeeper, include ZKQuorum and ZKClusterID
# They can also be specified on the connection string.
- # AuthenticationType: No authentication; Basic Authentication
- ConnectionType=ZooKeeper
+ # AuthenticationType:No authentication;Plain;Kerberos
+ ConnectionType=Direct
HOST=
PORT=
- ZKQuorum=centos23:5181,centos28:5181,centos29:5181
- ZKClusterID=docs41cluster-drillbits
+ ZKQuorum=[Zookeeper Quorum]
+ ZKClusterID=[Cluster ID]]
AuthenticationType=No Authentication
UID=[USERNAME]
PWD=[PASSWORD]
+ DelegationUID=
+ KrbServiceHost=mapr
+ KrbServiceName=
AdvancedProperties=CastAnyToVarchar=true;HandshakeTimeout=5;QueryTimeout=180;TimestampTZDisplayTimezone=utc;ExcludedSchemas=sys,INFORMATION_SCHEMA;NumberOfPrefetchBuffers=5;
Catalog=DRILL
Schema=
+ [MapR Drill 64-bit]
+ # This key is not necessary and only describes the data source.
+ Description=MapR Drill ODBC Driver (64-bit) DSN
+
+ # Driver: The location where the ODBC driver is installed to.
+ Driver=/opt/mapr/drill/lib/64/libdrillodbc_sb64.so
+
# The DriverUnicodeEncoding setting is only used for SimbaDM
+ # When set to 1, SimbaDM runs in UTF-16 mode.
+ # When set to 2, SimbaDM runs in UTF-8 mode.
+ # DriverUnicodeEncoding=2
+
+ # Values for ConnectionType, AdvancedProperties, Catalog, Schema should be set here.
+ # If ConnectionType is Direct, include Host and Port. If ConnectionType is ZooKeeper, include ZKQuorum and ZKClusterID
+ # They can also be specified on the connection string.
+ # AuthenticationType:No authentication;Plain;Kerberos;MapRSASL
+ ConnectionType=Direct
+ HOST=
+ PORT=
+ ZKQuorum=[Zookeeper Quorum]
+ ZKClusterID=[Cluster ID]]
+ AuthenticationType=No Authentication
+ UID=[USERNAME]
+ PWD=[PASSWORD]
+ DelegationUID=
+ KrbServiceHost=mapr
+ KrbServiceName=
+ AdvancedProperties=CastAnyToVarchar=true;HandshakeTimeout=5;QueryTimeout=180;TimestampTZDisplayTimezone=utc;ExcludedSchemas=sys,INFORMATION_SCHEMA;NumberOfPrefetchBuffers=5;
+ Catalog=DRILL
+ Schema=
### Authentication Properties
-To password protect the DSN, uncomment the AuthenticationType, select Basic Authentication for the AuthenticationType, and configure UID and PWD properties.
+If the Drillbit requires authentication, uncomment the AuthenticationType, add an AuthenticationType, and configure properties. If the Drillbit does not require authentication (or to configure no password protection), you can use the No Authentication option; you do not need to configure additional settings.
+
+
+* **MapRSASL**
+ * The MapR login utility must be used to obtain a MapR ticket for MapR SASL authentication.
+ * You must install and configure the MapR login utility before you can use the MapR SASL authentication mechanism. See <a href="http://maprdocs.mapr.com/home/SecurityGuide/SecurityArchitecture-AuthenticationArchitecture.html" title="MapR Login Utilty">Authentication Architecture: The maprlogin Utility</a> and <a href="http://maprdocs.mapr.com/home/SecurityGuide/Tickets.html/">Tickets</a>.
+
+ **Kerberos**
+ * See the <a href="http://web.mit.edu/kerberos/" title="MIT Kerberos">MIT Kerberos</a> documentation for installing and configuring a Kerberos environment, which is beyond the scope of the information provided here.
+ * To specify the Kerberos mechanism:
+ * Set the AuthenticationType to Kerberos.
+ * Set the KrbServiceHost property to the FQDN of the Drill server host.
+ * Set the KrbServiceName property to the Kerberos service principal name of the Drill server.
+
+ **Plain (or Basic Authentication)**
+ * Configure the UID to an appropriate name for accessing the Drill server.
+ * Set the PWD property to the password corresponding to the UID.
### Direct and ZooKeeper Quorum Properties
To use Drill in distributed mode, set ConnectionType to Zookeeper, get the ZKQuorum and ZKClusterID values from the `drill-override.conf` file, and define the ZKQuorum and ZKClusterID properties. The `drill-override.conf` is in the `/drill/drill-<version>/conf` directory. Format ZKQuorum as a comma separated list of ZooKeeper nodes in the following format:
@@ -119,7 +165,7 @@ For example:
To use Drill in embedded mode, do not define the ZKQuorum and ZKClusterID properties. Start Drill using the drill-localhost command, set ConnectionType to Direct, and define HOST and PORT properties. For example:
-* `HOST=centos32.lab:5181`
+* `HOST=<IP address of drillbit>:5181`
* `PORT=31010`
[Driver Configuration Options]({{ site.baseurl }}/docs/odbc-configuration-reference/#configuration-options) describes configuration options available for controlling the
@@ -136,17 +182,16 @@ directly in the` .odbc.ini` configuration file. The `.odbinst.ini` file contains
**Example**
[ODBC Drivers]
- [ODBC Drivers]
MapR Drill ODBC Driver 32-bit=Installed
MapR Drill ODBC Driver 64-bit=Installed
[MapR Drill ODBC Driver 32-bit]
- Description=MapR Drill ODBC Driver(32-bit)
- Driver=/opt/mapr/drillodbc/lib/32/libmaprdrillodbc32.so
+ Description=MapR Drill ODBC Driver (32-bit)
+ Driver=/opt/mapr/lib/32/libdrillodbc_sb32.so
[MapR Drill ODBC Driver 64-bit]
- Description=MapR Drill ODBC Driver(64-bit)
- Driver=/opt/mapr/drillodbc/lib/64/libmaprdrillodbc64.so
+ Description=MapR Drill ODBC Driver (64-bit)
+ Driver=/opt/mapr/lib/64/libdrillodbc_sb64.so
----------
@@ -160,37 +205,32 @@ file. This configures the driver to work with your ODBC driver manager. The foll
. . .
[Driver]
DisableAsync=0
- DriverManagerEncoding=UTF-32
- ErrorMessagesPath=/opt/mapr/drillodbc/ErrorMessages
+ ErrorMessagesPath=/opt/mapr/drill/ErrorMessages
LogLevel=0
LogPath=[LogPath]
SwapFilePath=/tmp
- ## - Uncomment the ODBCInstLib corresponding to the Driver Manager being used.
## - Note that the path to your ODBC Driver Manager must be specified in LD_LIBRARY_PATH.
- # Generic ODBCInstLib
- # iODBC
- ODBCInstLib=libiodbcinst.so
. . .
### Configuring .mapr.drillodbc.ini
-To configure the MapR Drill ODBC Driver in the `mapr.drillodbc.ini` configuration file, complete the following steps:
+To configure the MapR Drill ODBC Driver in the `.mapr.drillodbc.ini` configuration file, complete the following steps:
- 1. Open the `mapr.drillodbc.ini` configuration file in a text editor.
- 2. Edit the DisableAsync setting if you want to enable a synchronous ODBC connection for performance reasons. Change the default 0 to 1 to disable the asynchronous and enable the synchronous connection.
+ 1. Open the `.mapr.drillodbc.ini` configuration file in a text editor.
+
+ 2. Edit the DisableAsync setting if you want to enable a synchronous ODBC connection for performance reasons. Change the default 0 to 1 to disable the asynchronous and enable the synchronous connection.
A change in state occurs during driver initialization and is propagated to all driver DSNs.
- 3. Edit the DriverManagerEncoding setting if necessary. The value is typically UTF-16 or UTF-32, but depends on the driver manager used. iODBC uses UTF-32 and unixODBC uses UTF-16. Review your ODBC Driver Manager documentation for the correct setting.
- 4. Edit the `ODBCInstLib` setting. The value is the name of the `ODBCInst` shared library for the ODBC driver manager that you use. The configuration file defaults to the shared library for `iODBC`. In Linux, the shared library name for iODBC is `libiodbcinst.so`.
-
- Specify an absolute or relative filename for the library. If you use
-the relative file name, include the path to the library in the library path
-environment variable. The library path environment variable is named
-`LD_LIBRARY_PATH`.
- 5. Save the `mapr.drillodbc.ini` configuration file.
+
+ **Note**: As of version 1.3.8 of the driver, the DriverManagerEncoding setting is automatically detected and set if necessary. The value is typically UTF-16 or UTF-32, but depends on the driver manager used. iODBC uses UTF-32 and unixODBC uses UTF-16.
+
+ 4. Save the `.mapr.drillodbc.ini` configuration file.
+
### Next Step
Refer to [Testing the ODBC Connection]({{ site.baseurl }}/docs/testing-the-odbc-connection).
+
+
http://git-wip-us.apache.org/repos/asf/drill/blob/ee71b646/_docs/odbc-jdbc-interfaces/configuring-odbc/025-configuring-odbc-on-mac-os-x.md
----------------------------------------------------------------------
diff --git a/_docs/odbc-jdbc-interfaces/configuring-odbc/025-configuring-odbc-on-mac-os-x.md b/_docs/odbc-jdbc-interfaces/configuring-odbc/025-configuring-odbc-on-mac-os-x.md
index da36b28..d83ff36 100644
--- a/_docs/odbc-jdbc-interfaces/configuring-odbc/025-configuring-odbc-on-mac-os-x.md
+++ b/_docs/odbc-jdbc-interfaces/configuring-odbc/025-configuring-odbc-on-mac-os-x.md
@@ -1,36 +1,35 @@
---
title: "Configuring ODBC on Mac OS X"
-date: 2017-01-24 22:24:25 UTC
+date: 2017-05-30 23:11:52 UTC
parent: "Configuring ODBC"
---
ODBC driver managers use configuration files to define and configure ODBC data
-sources and drivers. To configure an ODBC connection for Linux or Mac OS X, complete the following
-steps:
+sources and drivers. To configure an ODBC connection for Mac OS X, note the following
+procedure:
-* [Step 1: Copy Sample Configuration Files]({{site.baseurl}}/docs/configuring-odbc-on-mac-os-x/#step-1:-copy-sample-configuration-files)
+* [Step 1: Driver Installer Updates Sample Configuration Files]({{site.baseurl}}/docs/configuring-odbc-on-mac-os-x/#step-1:-driver-installer-updates-sample-configuration-files)
* [Step 2: Set Environment Variables]({{site.baseurl}}/docs/configuring-odbc-on-mac-os-x/#step-2:-set-environment-variables)
* [Step 3: Define the ODBC Data Sources in odbc.ini]({{site.baseurl}}/docs/configuring-odbc-on-mac-os-x/#step-3:-define-the-odbc-data-sources-in-.odbc.ini)
* [Step 4: Configure the MapR Drill ODBC Driver]({{site.baseurl}}/docs/configuring-odbc-on-mac-os-x/#step-4:-configure-the-mapr-drill-odbc-driver)
-## Step 1: Copy Sample Configuration Files
+## Step 1: Driver Installer Updates Sample Configuration Files
-Before you connect to Drill through an ODBC client tool
-on Mac OS X, copy the following configuration files in `/opt/mapr/drill/Setup` to your home directory unless the files already exist in your home directory:
+Before you connect to Drill through an ODBC client tool on Mac OS X, the driver installer copies the following configuration files in `/Library/mapr/drill/Setup` to your home directory unless the files already exist in your home directory:
* `mapr.drillodbc.ini`
-* `.odbc.ini`
-* `.odbcinst.ini`
+* `odbc.ini`
+* `odbcinst.ini`
In your home directory, rename the files as hidden files. Use sudo if necessary:
-* .mapr.drillodbc.ini
-* .odbc.ini
-* .odbcinst.ini
+* `.mapr.drillodbc.ini`
+* `.odbc.ini`
+* `.odbcinst.ini`
-The installer for Mac OS X creates a sample user DSN in odbc.ini in either of the following locations:
+The installer for Mac OS X creates a sample user DSN in `odbc.ini` in either of the following locations:
-* ~/Library/ODBC/odbc.ini
-* ~/.odbc.ini
+* `~/Library/ODBC/odbc.ini`
+* `~/.odbc.ini`
Depending on the driver manager you use, the user DSN in one of these files will be effective.
@@ -40,9 +39,9 @@ Depending on the driver manager you use, the user DSN in one of these files will
## Step 2: Set Environment Variables
-Create or modify the `/etc/launchd.conf` file to set environment variables. Set the MAPRDRILLINI variable to point to the `.mapr.drillodbc.ini` file.
+The driver installer installs the `.mapr.drillodbc.ini` file to your home directory and adds an entry to the `$HOME/.odbc.ini` file.
-If you installed the iODBC driver manager using the DMG, the dynamic linker (DYLD) libraries are installed in `/usr/local/iODBC/lib`. The launchd.conf file should look something like this:
+If you installed the iODBC driver manager using the DMG, the dynamic linker (DYLD) libraries are installed in `/usr/local/iODBC/lib`. The `launchd.conf` file contains contents such as the following:
setenv MAPRDRILLINI /Users/joeuser/.mapr.drillodbc.ini
setenv ODBCINI /Users/joeuser/.odbc.ini
@@ -72,7 +71,25 @@ You set the following properties for using Drill in distributed mode:
ZKClusterID=<cluster name in `drill-override.conf`>
### Authentication Properties
-If the Drillbit requires a username and password for authentication, uncomment the AuthenticationType, select Basic Authentication for the AuthenticationType, and configure UID and PWD properties.
+If the Drillbit requires authentication, uncomment the AuthenticationType, add an AuthenticationType, and configure properties. If the Drillbit does not require authentication (or to configure no password protection), you can use the No Authentication option; you do not need to configure additional settings.
+
+
+* **MapRSASL**
+ * The MapR login utility must be used to obtain a MapR ticket for MapR SASL authentication.
+ * You must install and configure the MapR login utility before you can use the MapR SASL authentication mechanism. See <a href="http://maprdocs.mapr.com/home/SecurityGuide/SecurityArchitecture-AuthenticationArchitecture.html" title="MapR Login Utilty">Authentication Architecture: The maprlogin Utility</a> and <a href="http://maprdocs.mapr.com/home/SecurityGuide/Tickets.html/">Tickets</a>.
+
+ **Kerberos**
+ * See the <a href="http://web.mit.edu/kerberos/" title="MIT Kerberos">MIT Kerberos</a> documentation for installing and configuring a Kerberos environment, which is beyond the scope of the information provided here.
+ * To specify the Kerberos mechanism:
+ * Set the AuthenticationType to Kerberos.
+ * Set the KrbServiceHost property to the FQDN of the Drill server host.
+ * Set the KrbServiceName property to the Kerberos service principal name of the Drill server.
+
+ **Plain (or Basic Authentication)**
+ * Configure the UID to an appropriate name for accessing the Drill server.
+ * Set the PWD property to the password corresponding to the UID.
+
+To configure no password protection, select No Authentication.
### Direct and ZooKeeper Quorum Properties
To use Drill in distributed mode, set ConnectionType to Zookeeper, get the ZKQuorum and ZKClusterID values from the `drill-override.conf` file, and define the ZKQuorum and ZKClusterID properties. Format ZKQuorum as a comma separated list of ZooKeeper nodes in the following format:
@@ -85,7 +102,7 @@ For example:
To use Drill in local mode, do not define the ZKQuorum and ZKClusterID properties. Start Drill using the drill-localhost command, set ConnectionType to Direct, and define HOST and PORT properties. For example:
-* `HOST=centos32.lab:5181`
+* `HOST=<IP address of drillbit>:5181`
* `PORT=31010`
[Driver Configuration Options]({{ site.baseurl }}/docs/odbc-configuration-reference/#configuration-options) describes configuration options available for controlling the
@@ -101,37 +118,44 @@ The following sample shows a possible configuration for using Drill in embedded
# Specify any global ODBC configuration here such as ODBC tracing.
[ODBC Data Sources]
- Sample MapR Drill=MapR Drill ODBC Driver
+ MapR Drill=MapR Drill ODBC Driver
- [Sample MapR Drill]
+ [MapR Drill]
# Description: DSN Description.
# This key is not necessary and only describes the data source.
- Description=Sample MapR Drill ODBC Driver DSN
+ Description=MapR Drill ODBC Driver
# Driver: The location where the ODBC driver is installed.
Driver=/Library/mapr/drill/lib/libdrillodbc_sbu.dylib
- # The DriverUnicodeEncoding setting is only used for SimbaDM
- # When set to 1, SimbaDM runs in UTF-16 mode.
- # When set to 2, SimbaDM runs in UTF-8 mode.
+ # The DriverUnicodeEncoding setting is only used for MapRDM
+ # When set to 1, MapRDM runs in UTF-16 mode.
+ # When set to 2, MapRDM runs in UTF-8 mode.
#DriverUnicodeEncoding=2
# Values for ConnectionType, AdvancedProperties, Catalog, Schema should be set here.
# If ConnectionType is Direct, include Host and Port. If ConnectionType is ZooKeeper, include ZKQuorum and ZKClusterID
# They can also be specified on the connection string.
- # AuthenticationType: No authentication; Basic Authentication
+ # AuthenticationType: No authentication; Plain; Kerberos; MapRSASL
ConnectionType=Direct
HOST=localhost
PORT=31010
ZKQuorum=[Zookeeper Quorum]
ZKClusterID=[Cluster ID]
- AuthenticationType=No Authentication
+ AuthenticationType=Plain
UID=[USERNAME]
PWD=[PASSWORD]
- AdvancedProperties=CastAnyToVarchar=true;HandshakeTimeout=5;QueryTimeout=180;TimestampTZDisplayTimezone=utc;ExcludedSchemas=sys,INFORMATION_SCHEMA;NumberOfPrefetchBuffers=5;
+ DelegationUID=
+ KrbServiceHost=
+ KrbServiceName=
+ AdvancedProperties=CastAnyToVarchar=true;HandshakeTimeout=30;QueryTimeout=180;TimestampTZDisplayTimezone=utc;
+ ExcludedSchemas=sys,INFORMATION_SCHEMA;NumberOfPrefetchBuffers=5;
Catalog=DRILL
Schema=
+ # The DriverUnicodeEncoding setting is only used for MapRDM
+
+
----------
@@ -161,7 +185,7 @@ To configure the MapR Drill ODBC Driver in the `mapr.drillodbc.ini` configuratio
3. Edit the DriverManagerEncoding setting if necessary. The value is typically UTF-16 or UTF-32, but depends on the driver manager used. iODBC uses UTF-32 and unixODBC uses UTF-16. Review your ODBC Driver Manager documentation for the correct setting.
4. Save the `mapr.drillodbc.ini` configuration file.
+
### Next Step
Refer to [Testing the ODBC Connection]({{ site.baseurl }}/docs/testing-the-odbc-connection).
-
http://git-wip-us.apache.org/repos/asf/drill/blob/ee71b646/_docs/odbc-jdbc-interfaces/configuring-odbc/030-configuring-odbc-on-windows.md
----------------------------------------------------------------------
diff --git a/_docs/odbc-jdbc-interfaces/configuring-odbc/030-configuring-odbc-on-windows.md b/_docs/odbc-jdbc-interfaces/configuring-odbc/030-configuring-odbc-on-windows.md
index e910d61..1509e86 100644
--- a/_docs/odbc-jdbc-interfaces/configuring-odbc/030-configuring-odbc-on-windows.md
+++ b/_docs/odbc-jdbc-interfaces/configuring-odbc/030-configuring-odbc-on-windows.md
@@ -1,34 +1,40 @@
---
title: "Configuring ODBC on Windows"
-date:
+date: 2017-05-30 23:11:53 UTC
parent: "Configuring ODBC"
---
-
Complete one of the following steps to create an ODBC connection on Windows to Drill data
sources:
* Create a Data Source Name
* Create an ODBC Connection String
-## Sample ODBC Configuration (DSN)
+## Sample ODBC Configuration
-You can see how to create a DSN to connect to Drill data sources by taking a look at the preconfigured sample that the installer sets up. If
-you want to create a DSN for a 32-bit application, you must use the 32-bit
+You can see how to create a DSN to connect to Drill data sources by taking a look at the preconfigured sample that the installer sets up. If you want to create a DSN for a 32-bit application, you must use the 32-bit
version of the ODBC Administrator to create the DSN.
-1. Click **Start**, and locate the ODBC Administrator app that you installed, and click ODBC Administrator to start the app.
+1. Click **Start** and locate the ODBC Administrator app that you installed. Then click ODBC Administrator to start the app.
The ODBC Data Source Administrator dialog appears.
-2. On the **System DSN** tab in System Data Sources, select the sample MapR ODBC Driver for Drill DSN.
+2. On the **System DSN** tab in System Data Sources, select the sample MapR Drill.
- The system DSN is available for all users who log in to the machine. You can set up a user DSN is available only to the user who creates the DSN.
+ The system DSN is available for all users who log in to the machine. You can set up a user DSN is available only to the user who creates the DSN on the **User DSN** tab.
3. Click **Configure**.
- The MapR Drill ODBC Driver DSN Setup dialog appears with a preconfigured sample DSN. The following screenshot shows a possible DSN configuration for using Drill in embedded mode.
+ The MapR Drill setup dialog appears with a preconfigured sample DSN. The following screenshot shows a possible DSN configuration for using Drill in embedded mode.
### Authentication Options
-To password protect the DSN, uncomment the AuthenticationType, select Basic Authentication in the Authentication Type dropdown, and configure UID and PWD properties. To configure no password protection, select No Authentication.
+To password protect the DSN, select the appropriate AuthenticationType in the dropdown. If the Drillbit does not require authentication (or to configure no password protection), you can use the No Authentication option; you do not need to configure additional settings.
+
+* **MapR-SASL**
+ * The maprlogin utility must be used to obtain a MapR ticket. To install and use the MapR login utility, see <a href="http://maprdocs.mapr.com/home/SecurityGuide/SecurityArchitecture-AuthenticationArchitecture.html" title="MapR Login Utilty">Authentication Architecture: The maprlogin Utility</a> and <a href="http://maprdocs.mapr.com/home/SecurityGuide/Tickets.html/">Tickets</a>.
+* **Kerberos** - configure Host FQDN and Service Name properties.
+ * To specify the default Kerberos mechanism, select the Use Only SSPI checkbox.
+ * To use MIT Kerberos by default and only use the SSPI plugin if the GSSAPI library is not available, clear the Use Only SSPI checkbox.
+* **Plain Authentication** - configure UID and PWD properties.
+
### Direct to Drillbit and ZooKeeper Quorum Options
In the Connection Type section, Direct to Drillbit is selected for using Drill in embedded mode. To use Drill in embedded mode, set ConnectionType to Direct and define HOST and PORT properties. For example:
@@ -42,10 +48,10 @@ To use Drill in distributed mode, select ZooKeeper Quorum.
If you select ZooKeeper Quorum, provide values for the following properties:
-* Quorum
+* Quorum -
A comma separated list of ZooKeeper nodes in the following format:
`<host name/ip address> : <port number>, <host name/ip address> : <port number>, . . .`
-* Cluster ID
+* Cluster ID -
Name of the drillbit cluster. Check the drill-override.conf file for ZooKeeper node information and for any cluster name changes.
Check the `drill-override.conf` file for the cluster name.
@@ -61,4 +67,3 @@ Select the Disable Async option to disable the asynchronous ODBC connection and
### Next Step
[Testing the ODBC Connection]({{ site.baseurl }}/docs/testing-the-odbc-connection/).
-