Skip to content

Commit 854ebff

Browse files
itrczpaveltiunov
itrcz
authored and
paveltiunov
committed
feat: Oracle driver (#160)
* Oracle driver added * add ramda for OracleDriver * remove try from getConnection * Add "AS" syntax overwrite functions for Oracle * Oracle dialect added * add asSyntax getter for oracle in BaseQuery * change to getter * fix tablesSchema query * fix asSyntaxTable * add OracleFilter
1 parent dc45fcb commit 854ebff

File tree

9 files changed

+497
-12
lines changed

9 files changed

+497
-12
lines changed

‎packages/cubejs-oracle-driver/LICENSE

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright 2018-2019 Statsbot, Inc.
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎packages/cubejs-oracle-driver/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Cube.js Oracle Database Driver
2+
3+
Pure Javascript Oracle driver.
4+
5+
[Learn more](https://github.com/statsbotco/cube.js#getting-started)
6+
7+
### License
8+
9+
Cube.js Oracle Database Driver is [Apache 2.0 licensed](./LICENSE).

‎packages/cubejs-oracle-driver/driver/OracleDriver.js

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
const BaseDriver = require('@cubejs-backend/query-orchestrator/driver/BaseDriver');
2+
const oracledb = require('oracledb');
3+
const { reduce } = require('ramda');
4+
5+
const sortByKeys = (unordered) => {
6+
const ordered = {};
7+
8+
Object.keys(unordered).sort().forEach((key) => {
9+
ordered[key] = unordered[key];
10+
});
11+
12+
return ordered;
13+
};
14+
15+
const reduceCb = (result, i) => {
16+
let schema = (result[i.table_schema] || {});
17+
let tables = (schema[i.table_name] || []);
18+
let attributes = new Array();
19+
20+
if (i.key_type === "P" || i.key_type === "U") {
21+
attributes.push(["primaryKey"]);
22+
/**
23+
* ScaffoldingSchema.js line 139
24+
* seems like a bug
25+
* TODO: remove this after method
26+
* dimensionColumns change
27+
*/
28+
attributes.primaryKey = true;
29+
}
30+
31+
tables.push({
32+
name: i.column_name,
33+
type: i.data_type,
34+
attributes
35+
});
36+
37+
schema[i.table_name] = tables.sort();
38+
result[i.table_schema] = sortByKeys(schema);
39+
40+
return sortByKeys(result);
41+
};
42+
43+
class OracleDriver extends BaseDriver {
44+
constructor(config) {
45+
super();
46+
this.db = oracledb;
47+
this.db.outFormat = this.db.OBJECT;
48+
this.db.partRows = 100000;
49+
this.db.maxRows = 100000;
50+
this.db.prefetchRows = 500;
51+
52+
this.config = config || {
53+
user: process.env.CUBEJS_DB_USER,
54+
password: process.env.CUBEJS_DB_PASS,
55+
db: process.env.CUBEJS_DB_NAME,
56+
host: process.env.CUBEJS_DB_HOST,
57+
port: 1521,
58+
poolMin: 0,
59+
poolMax: 50,
60+
};
61+
62+
if (!this.config.connectionString) {
63+
this.config.connectionString = `${this.config.host}/${this.config.db}`
64+
}
65+
}
66+
67+
async tablesSchema() {
68+
const data = await this.query(`
69+
select tc.owner "table_schema"
70+
, tc.table_name "table_name"
71+
, tc.column_name "column_name"
72+
, tc.data_type "data_type"
73+
, c.constraint_type "key_type"
74+
from all_tab_columns tc
75+
left join all_cons_columns cc
76+
on (tc.owner, tc.table_name, tc.column_name)
77+
in ((cc.owner, cc.table_name, cc.column_name))
78+
left join all_constraints c
79+
on (tc.owner, tc.table_name, cc.constraint_name)
80+
in ((c.owner, c.table_name, c.constraint_name))
81+
and c.constraint_type
82+
in ('P','U')
83+
where tc.owner = user
84+
`);
85+
86+
return reduce(reduceCb, {}, data);
87+
}
88+
89+
async getConnectionFromPool() {
90+
if (!this.pool) {
91+
this.pool = await this.db.createPool(this.config);
92+
}
93+
return this.pool.getConnection()
94+
}
95+
96+
async testConnection() {
97+
return (
98+
await this.getConnectionFromPool()
99+
).execute('SELECT 1 FROM DUAL');
100+
}
101+
102+
async query(query, values) {
103+
const conn = await this.getConnectionFromPool();
104+
try {
105+
const res = await conn.execute(query, values || {});
106+
return res && res.rows;
107+
} catch (e) {
108+
throw (e);
109+
}
110+
}
111+
112+
release() {
113+
return this.pool && this.pool.close();
114+
}
115+
}
116+
117+
module.exports = OracleDriver;

‎packages/cubejs-oracle-driver/package.json

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"name": "@cubejs-backend/oracle-driver",
3+
"description": "Cube.js oracle database driver",
4+
"author": "Trikoz I.",
5+
"version": "0.10.12",
6+
"engines": {
7+
"node": ">=8.11.1"
8+
},
9+
"main": "driver/OracleDriver.js",
10+
"scripts": {
11+
"test": "mocha"
12+
},
13+
"dependencies": {
14+
"@cubejs-backend/query-orchestrator": "^0.10.12",
15+
"oracledb": "^3.1.2",
16+
"ramda": "^0.26.1"
17+
},
18+
"license": "Apache-2.0"
19+
}

‎packages/cubejs-oracle-driver/yarn.lock

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
2+
# yarn lockfile v1
3+
4+
5+
"@cubejs-backend/query-orchestrator@^0.10.12":
6+
version "0.10.12"
7+
resolved "https://registry.yarnpkg.com/@cubejs-backend/query-orchestrator/-/query-orchestrator-0.10.12.tgz#4b396ec4995949a09fdc3c8f596693cce952f897"
8+
dependencies:
9+
ramda "^0.24.1"
10+
redis "^2.8.0"
11+
12+
double-ended-queue@^2.1.0-0:
13+
version "2.1.0-0"
14+
resolved "https://registry.yarnpkg.com/double-ended-queue/-/double-ended-queue-2.1.0-0.tgz#103d3527fd31528f40188130c841efdd78264e5c"
15+
16+
generic-pool@^3.6.0:
17+
version "3.6.0"
18+
resolved "https://registry.yarnpkg.com/generic-pool/-/generic-pool-3.6.0.tgz#34e3124d9af754c8bfee7c15906e7347dc543afc"
19+
20+
oracledb@^3.1.2:
21+
version "3.1.2"
22+
resolved "https://registry.yarnpkg.com/oracledb/-/oracledb-3.1.2.tgz#4d7df7b8eda161d4e645837cd43c530232d139e8"
23+
24+
ramda@^0.24.1:
25+
version "0.24.1"
26+
resolved "https://registry.yarnpkg.com/ramda/-/ramda-0.24.1.tgz#c3b7755197f35b8dc3502228262c4c91ddb6b857"
27+
28+
redis-commands@^1.2.0:
29+
version "1.4.0"
30+
resolved "https://registry.yarnpkg.com/redis-commands/-/redis-commands-1.4.0.tgz#52f9cf99153efcce56a8f86af986bd04e988602f"
31+
32+
redis-parser@^2.6.0:
33+
version "2.6.0"
34+
resolved "https://registry.yarnpkg.com/redis-parser/-/redis-parser-2.6.0.tgz#52ed09dacac108f1a631c07e9b69941e7a19504b"
35+
36+
redis@^2.8.0:
37+
version "2.8.0"
38+
resolved "https://registry.yarnpkg.com/redis/-/redis-2.8.0.tgz#202288e3f58c49f6079d97af7a10e1303ae14b02"
39+
dependencies:
40+
double-ended-queue "^2.1.0-0"
41+
redis-commands "^1.2.0"
42+
redis-parser "^2.6.0"

0 commit comments

Comments
 (0)