@@ -17,7 +17,122 @@ Overview
17
17
18
18
|bi-short| provides the following environment variables:
19
19
20
- .. include:: /includes/fact-system-vars.rst
20
+ .. list-table::
21
+ :widths: 30 10 40 10 10
22
+ :stub-columns: 1
23
+ :header-rows: 1
24
+
25
+ * - System Variable
26
+ - Data Type
27
+ - Description
28
+ - Default Value (Atlas-hosted)
29
+ - Default Value (On Premises)
30
+ * - ``full_pushdown_exec_mode``
31
+ - boolean
32
+ - Specifies whether a query error is returned for queries with
33
+ clauses that aren't fully translated to the MongoDB query language.
34
+ SQL query predicates are used to filter data returned by the query.
35
+ - ``0 (false)``
36
+ - ``0 (false)``
37
+ * - ``log_level``
38
+ - integer
39
+ - Specifies the logging level for |bi-short|:
40
+
41
+ - ``-1``: Do not log.
42
+ - ``0``: Log only messages for database users, such as basic
43
+ ``mongosqld`` events and state changes.
44
+ - ``1``: Log messages for database users and ``mongosqld`` administrators.
45
+ - ``2``: For internal use only.
46
+ - ``2``
47
+ - ``0``
48
+ * - ``max_nested_table_depth``
49
+ - integer
50
+ - Specifies the maximum number of unique nested field paths that
51
+ ``mongosqld`` maps to a relational table for a collection.
52
+ - ``50``
53
+ - ``50``
54
+ * - ``max_num_columns_per_table``
55
+ - integer
56
+ - The maximum number of unique fields that ``mongosqld`` maps to
57
+ relational columns for a collection.
58
+ - ``1000``
59
+ - ``1000``
60
+ * - ``mongodb_max_varchar_length``
61
+ - integer
62
+ - Specifies the maximum string length returned for columns using
63
+ the ``VARCHAR`` data type. A value of ``0`` specifies
64
+ no limit.
65
+ - ``0``
66
+ - ``0``
67
+ * - ``polymorphic_type_conversion_mode``
68
+ - string
69
+ - Determines how |bi-short| evaluates document fields that are
70
+ specified with multiple data types. For example, ``count``
71
+ could be a number in one document and a string in another.
72
+ The data type that |bi-short| selects depends on the value
73
+ of the ``schema_mapping_mode`` system variable. A value of
74
+ ``majority`` causes |bi-short| to select the type
75
+ that appears in the majority of document fields, while a value
76
+ of ``lattice`` would cause |bi-short| to select string as the
77
+ data type for ``count``. See :doc:`Cached Sampling </schema/cached-sampling>`
78
+ for more information.
79
+
80
+ Set ``polymorphic_type_conversion_mode`` to one of the following
81
+ values:
82
+
83
+ - ``off``:
84
+ Queries may fail if you do not explicitly cast
85
+ document fields that are specified with multiple data types.
86
+ - ``fast``:
87
+ |bi-short| converts only document fields that
88
+ appeared as multiple data types during sampling.
89
+ - ``safe``:
90
+ |bi-short| converts all document fields to the data type
91
+ discovered during sampling, even if the fields do not appear
92
+ as multiple data types.
93
+ - ``off``
94
+ - ``off``
95
+ * - ``sample_refresh_interval_secs``
96
+ - integer
97
+ - Specifies how frequently, in seconds, that the |bi-short| schema
98
+ is updated. A value of ``0`` specifies that the schema is not
99
+ refreshed after |bi-short| starts.
100
+
101
+ See :doc:`Cached Sampling </schema/cached-sampling>` for more
102
+ information.
103
+ - ``0``
104
+ - ``0``
105
+ * - ``sample_size``
106
+ - integer
107
+ - Specifies how many documents |bi-short| samples when generating
108
+ its schema. A value of ``0`` specifies that |bi-short| performs
109
+ a collection scan across all sample :option:`namespaces <mongosqld --sampleNamespaces>`.
110
+
111
+ See :doc:`Cached Sampling </schema/cached-sampling>` for more
112
+ information.
113
+ - ``100``
114
+ - ``100``
115
+ * - ``schema_mapping_mode``
116
+ - string
117
+ - Specifies how the MongoDB schema is transformed into a relational
118
+ schema:
119
+
120
+ - ``lattice``: See :doc:`Sampling Type Conflicts </schema/type-conflicts>`
121
+ for more information.
122
+ - ``majority``: |bi-short| assigns the most common data type for
123
+ a field occuring in a sample.
124
+
125
+ - ``lattice``
126
+ - ``lattice``
127
+ * - ``type_conversion_mode``
128
+ - string
129
+ - Specifies the semantics that |bi-short| uses for type conversions,
130
+ such as the ``CAST`` function.
131
+
132
+ - ``mysql``
133
+ - ``mongosql``
134
+ - ``mongosql``
135
+ - ``mongosql``
21
136
22
137
Setting System Variables
23
138
------------------------
0 commit comments