Skip to content

Commit 34b0c93

Browse files
zach-carrzach-carr
authored
2021 bic docs improvements (#355)
1 parent aff27d9 commit 34b0c93

21 files changed

+205
-229
lines changed

‎snooty.toml

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,12 @@ title = "MongoDB Connector for BI"
44
intersphinx = ["https://docs.mongodb.com/manual/objects.inv",
55
"https://docs.atlas.mongodb.com/objects.inv"]
66

7-
toc_landing_pages = ["/installation", "/client-applications", "/connect/mysql",
8-
"/authentication", "/schema-configuration", "/components",
9-
"/release-notes", "/connect/tableau"]
7+
toc_landing_pages = ["/installation", "/client-applications",
8+
"/connect/mysql",
9+
"/authentication", "/schema-configuration",
10+
"/components",
11+
"/release-notes", "/connect/tableau",
12+
"/reference/odbc-driver"]
1013

1114
[constants]
1215
atlas = "MongoDB Atlas"
@@ -20,7 +23,9 @@ download-center-bi = "`MongoDB Connector for BI <https://www.mongodb.com/downloa
2023
download-center-tableau = "`MongoDB Connector for BI <https://www.mongodb.com/download-center/bi-connector?jmp=tbl>`__"
2124
download-center-url = "https://www.mongodb.com/download-center/bi-connector"
2225
java-plugin = "MongoSQL Authentication Plugin for MySQL Connector/J"
23-
odbc-driver = "`MongoDB ODBC Driver for BI Connector <https://github.com/mongodb/mongo-bi-connector-odbc-driver/releases/>`__"
26+
odbc-driver-name = "MongoDB BI Connector ODBC Driver"
27+
odbc-driver = "`MongoDB BI Connector ODBC Driver <https://github.com/mongodb/mongo-bi-connector-odbc-driver/releases/>`__"
28+
jdbc-driver = "MySQL JDBC Driver"
2429
om-full = "MongoDB Ops Manager"
2530

2631
[substitutions]
@@ -49,7 +54,7 @@ kdc = ":abbr:`KDC (Key Distribution Center)`"
4954
kmip = ":abbr:`KMIP (Key Management Interoperability Protocol)`"
5055
ldaps = ":abbr:`LDAPS (Secure Lightweight Directory Access Protocol)`"
5156
ldap = ":abbr:`LDAP (Lightweight Directory Access Protocol)`"
52-
odbc-driver-name = "MongoDB ODBC driver"
57+
odbc-driver-name = "MongoDB BI Connector ODBC Driver"
5358
odbc = ":abbr:`ODBC (Open Database Connectivity)`"
5459
sasl = ":abbr:`SASL (Simple Authentication and Security Layer)`"
5560
scram = ":abbr:`SCRAM (Salted Challenge Response Authentication Mechanism)`"

‎source/atlas-bi-connector.txt

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
:noprevnext:
22

3+
.. _enable-bi-atlas:
4+
35
============================
46
Enable BI Connector in Atlas
57
============================
@@ -18,11 +20,11 @@ Enable BI Connector in Atlas
1820

1921
.. include:: /includes/atlas-bi-connector.rst
2022

21-
To install the {+bi-full+} on premises, see the
22-
:ref:`Installation Guides <installation-guides>`.
23-
2423
.. note::
2524

26-
You can also deploy the {+bi-full+} to the
25+
To install the {+bi-full+} locally instead, see the
26+
:ref:`Installation Guides <installation-guides>`.
27+
28+
You can also deploy the {+bi-full+} to
2729
:cloudmgr:`{+cm-full+} </tutorial/deploy-bi-connector/>` or
2830
:opsmgr:`{+om-full+} </tutorial/deploy-bi-connector/>`.

‎source/authentication.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -262,9 +262,9 @@ Client Authentication
262262
---------------------
263263

264264
If your :doc:`BI tool <client-applications>` is using the
265-
:doc:`MongoDB ODBC Driver </reference/odbc-driver>`, the driver will
265+
:doc:`{+odbc-driver+} </reference/odbc-driver>`, the driver will
266266
handle authentication and you do not need to install an authentication
267-
plugin. If you are not using the MongoDB ODBC Driver and need to
267+
plugin. If you are not using the {+odbc-driver+} and need to
268268
authenticate using your BI tool, install either the C or JDBC
269269
authentication plugin depending on which is compatible with your BI
270270
Tool:

‎source/components.txt

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,19 +30,60 @@ The following tools are available for use with the |bi|:
3030
and a MongoDB server.
3131
- :binary:`~bin.mongotranslate` translates a given SQL query into a
3232
MongoDB :manual:`aggregation pipeline </aggregation>`.
33-
- The :ref:`MongoDB ODBC driver <odbc-driver>` provides connectivity
33+
- The :ref:`{+odbc-driver-name+} <odbc-driver>` provides connectivity
3434
between SQL clients and the |bi|.
35+
- The :ref:`{+jdbc-driver+} <jdbc-driver>` provides an alternative
36+
connection method for some SQL clients and the |bi|.
3537
- The :ref:`C Authentication Plugin <install-auth-c-plugin>` and
3638
:ref:`JDBC Authentication Plugin <install-auth-jdbc-plugin>`
3739
facilitate secure transmission of authentication credentials between
3840
:binary:`~bin.mongosqld` and a MySQL client.
3941

42+
Choosing a Driver
43+
-----------------
44+
45+
Depending on your BI tool of choice, you connect to the
46+
|bi-short| with the :ref:`{+odbc-driver-name+} <odbc-driver>` or with
47+
the :ref:`{+jdbc-driver+} <jdbc-driver>`. The following table lists
48+
some common BI tools and their compatible drivers:
49+
50+
.. list-table::
51+
:header-rows: 1
52+
:widths: 50 25 25
53+
54+
* - BI Tool
55+
- {+odbc-driver-name+}
56+
- {+jdbc-driver+}
57+
58+
* - Tableau
59+
- :icon:`check`
60+
- :icon:`check`
61+
62+
* - MicroStrategy
63+
- :icon:`check`
64+
- :icon:`check`
65+
66+
* - Microsoft Power BI
67+
- :icon:`check`
68+
-
69+
70+
* - Microsoft Excel
71+
- :icon:`check`
72+
-
73+
74+
* - MySQL Workbench
75+
-
76+
- :icon:`check`
77+
78+
* - DBeaver
79+
-
80+
- :icon:`check`
4081

4182
.. toctree::
4283
:titlesonly:
4384

4485
/reference/mongosqld
4586
/reference/mongodrdl
4687
/reference/mongotranslate
47-
MongoDB ODBC Driver </reference/odbc-driver>
88+
{+odbc-driver-name+} </reference/odbc-driver>
4889
/reference/jdbc-driver

‎source/connect/microstrategy.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ This tutorial is for version MicroStrategy Desktop version 10.11.
3131
- Create a 64-bit :doc:`system Data Source Name (DSN)
3232
</tutorial/create-system-dsn>`.
3333

34-
- Install the :doc:`MongoDB ODBC driver
34+
- Install the :doc:`{+odbc-driver+}
3535
</reference/odbc-driver>` for Windows.
3636

3737
- Make sure you have a running :binary:`~bin.mongosqld`

‎source/includes/atlas-bi-connector.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
You can host the {+bi-full+} in {+atlas+} To learn how to connect to an
2-
Atlas-hosted {+bi-short+}, see
1+
You can host the {+bi-full+} in {+atlas+}. To learn how to enable and
2+
connect to an Atlas-hosted {+bi-short+}, see
33
:ref:`Connect via {+bi-atlas-short+} <bi-connection>`.

‎source/includes/steps-connect-tableau-mongosql-plugin-macos.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
title: Download and install the MongoDB ODBC driver.
1+
title: Download and install the {+odbc-driver+}.
22
ref: download-mongodb-odbc-driver-macos
33
level: 4
44
stepnum: 1
@@ -12,8 +12,8 @@ level: 4
1212
stepnum: 2
1313
content: |
1414
To securely connect Tableau to the |bi-short|, a system
15-
:abbr:`DSN (Data Source Name)` configured to use the MongoDB ODBC
16-
driver is required. To create a system DSN, follow the steps below:
15+
:abbr:`DSN (Data Source Name)` configured to use the {+odbc-driver+}
16+
is required. To create a system DSN, follow the steps below:
1717
1818
1919
.. include:: /includes/steps/create-system-dsn-auth-macos.rst

‎source/includes/steps-connect-tableau-mongosql-plugin-windows.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
title: Download and install the MongoDB ODBC driver.
1+
title: Download and install the {+odbc-driver+}.
22
ref: download-mongodb-odbc-driver-windows
33
level: 4
44
stepnum: 1
@@ -14,8 +14,8 @@ stepnum: 2
1414
content: |
1515
1616
To securely connect Tableau to the |bi-short|, a system
17-
:abbr:`DSN (Data Source Name)` configured to use the MongoDB ODBC
18-
driver is required. To create a system DSN, follow the steps below:
17+
:abbr:`DSN (Data Source Name)` configured to use the {+odbc-driver+}
18+
is required. To create a system DSN, follow the steps below:
1919
2020
.. include:: /includes/steps/create-system-dsn-auth.rst
2121

‎source/includes/steps-connect-tableau-mongosql-ssl-macos.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ level: 4
1111
stepnum: 2
1212
content: |
1313
To securely connect Tableau to the |bi-short|, a system
14-
:abbr:`DSN (Data Source Name)` configured to use the MongoDB ODBC
15-
driver is required. To create a system DSN, follow the steps below:
14+
:abbr:`DSN (Data Source Name)` configured to use the {+odbc-driver+}
15+
is required. To create a system DSN, follow the steps below:
1616
1717
.. include:: /includes/steps/create-system-dsn-auth-ssl-macos.rst
1818
---

‎source/includes/steps-connect-tableau-mongosql-ssl-windows.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
title: Download and install the MongoDB ODBC driver.
1+
title: Download and install the {+odbc-driver+}.
22
ref: download-mongodb-odbc-driver-windows-ssl
33
level: 4
44
stepnum: 1
@@ -13,8 +13,8 @@ stepnum: 2
1313
content: |
1414
1515
To securely connect Tableau to the |bi-short|, a system
16-
:abbr:`DSN (Data Source Name)` configured to use the MongoDB ODBC
17-
driver is required. To create a system DSN, follow the steps below:
16+
:abbr:`DSN (Data Source Name)` configured to use the {+odbc-driver+}
17+
is required. To create a system DSN, follow the steps below:
1818
1919
.. include:: /includes/steps/create-system-dsn-auth-ssl.rst
2020

‎source/includes/steps-connect-tableau-without-auth-macos.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
title: Download and install the MongoDB ODBC driver.
1+
title: Download and install the {+odbc-driver+}.
22
ref: download-mongodb-odbc-driver-macos-no-auth
33
stepnum: 1
44
level: 4
@@ -12,8 +12,8 @@ stepnum: 2
1212
level: 4
1313
content: |
1414
To securely connect Tableau to the |bi-short|, a system
15-
:abbr:`DSN (Data Source Name)` configured to use the MongoDB ODBC
16-
driver is required. To create a system DSN, follow the steps below:
15+
:abbr:`DSN (Data Source Name)` configured to use the {+odbc-driver+}
16+
is required. To create a system DSN, follow the steps below:
1717
1818
.. include:: /includes/steps/create-system-dsn-no-auth-macos.rst
1919
---

‎source/includes/steps-connect-tableau-without-auth-windows.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
title: Download and install the MongoDB ODBC driver.
1+
title: Download and install the {+odbc-driver+}.
22
ref: download-mongodb-odbc-driver-windows-no-auth
33
stepnum: 1
44
level: 4
@@ -13,8 +13,8 @@ stepnum: 2
1313
content: |
1414
1515
To securely connect Tableau to the |bi-short|, a system
16-
:abbr:`DSN (Data Source Name)` configured to use the MongoDB ODBC
17-
driver is required. To create a system DSN, follow the steps below:
16+
:abbr:`DSN (Data Source Name)` configured to use the {+odbc-driver+}
17+
is required. To create a system DSN, follow the steps below:
1818
1919
.. include:: /includes/steps/create-system-dsn-no-auth.rst
2020
---

‎source/includes/temp-warn-odbc-catalina.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
33
.. important::
44

5-
The 1.0.16 edition of ODBC Manager included with the MongoDB ODBC
6-
driver is not compatible with macOS Catalina. If you are on
5+
The 1.0.16 edition of ODBC Manager included with the {+odbc-driver+}
6+
is not compatible with macOS Catalina. If you are on
77
Catalina, download and install the
8-
`latest version (1.0.19) of ODBC manager. <http://www.odbcmanager.net/index.php>`__
8+
`latest version (1.0.19) of ODBC manager. <http://www.odbcmanager.net/index.php>`__

0 commit comments

Comments
 (0)