Skip to content

Commit f9b43d3

Browse files
committed
feat: Sqlite driver implementation
1 parent 7ca48d1 commit f9b43d3

File tree

9 files changed

+1205
-1
lines changed

9 files changed

+1205
-1
lines changed

packages/cubejs-mysql-driver/package.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,8 @@
1717
"generic-pool": "^3.6.0",
1818
"mysql": "^2.16.0"
1919
},
20-
"license": "Apache-2.0"
20+
"license": "Apache-2.0",
21+
"publishConfig": {
22+
"access": "public"
23+
}
2124
}

packages/cubejs-schema-compiler/adapter/QueryBuilder.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ const snowflake = require('./SnowflakeQuery');
1010
const clickhouse = require('./ClickHouseQuery');
1111
const hive = require('./HiveQuery');
1212
const oracle = require('./OracleQuery');
13+
const sqlite = require('./SqliteQuery');
1314

1415
const ADAPTERS = {
1516
postgres,
@@ -26,6 +27,7 @@ const ADAPTERS = {
2627
clickhouse,
2728
hive,
2829
oracle,
30+
sqlite,
2931
};
3032
exports.query = (compilers, dbType, queryOptions) => {
3133
if (!ADAPTERS[dbType]) {
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
const moment = require('moment-timezone');
2+
3+
const BaseQuery = require('./BaseQuery');
4+
const BaseFilter = require('./BaseFilter');
5+
6+
const GRANULARITY_TO_INTERVAL = {
7+
date: (date) => `strftime('%Y-%m-%dT00:00:00.000', ${date})`,
8+
week: (date) => `strftime('%Y-%m-%dT00:00:00.000', CASE WHEN date(${date}, 'weekday 1') = date(${date}) THEN date(${date}, 'weekday 1') ELSE date(${date}, 'weekday 1', '-7 days') END)`,
9+
hour: (date) => `strftime('%Y-%m-%dT%H:00:00.000', ${date})`,
10+
month: (date) => `strftime('%Y-%m-01T00:00:00.000', ${date})`,
11+
year: (date) => `strftime('%Y-01-01T00:00:00.000', ${date})`
12+
};
13+
14+
class SqliteFilter extends BaseFilter {
15+
likeIgnoreCase(column, not) {
16+
return `${column}${not ? ' NOT' : ''} LIKE '%' || ? || '%' COLLATE NOCASE`;
17+
}
18+
}
19+
20+
class SqliteQuery extends BaseQuery {
21+
newFilter(filter) {
22+
return new SqliteFilter(this, filter);
23+
}
24+
25+
convertTz(field) {
26+
return `${this.timeStampCast(field)} || '${
27+
moment().tz(this.timezone).format('Z')
28+
.replace('-', '+')
29+
.replace('+', '-')
30+
}'`;
31+
}
32+
33+
timeStampCast(value) {
34+
return `strftime('%Y-%m-%dT%H:%M:%f', ${value})`;
35+
}
36+
37+
dateTimeCast(value) {
38+
return `strftime('%Y-%m-%dT%H:%M:%f', ${value})`;
39+
}
40+
41+
subtractInterval(date, interval) {
42+
return `strftime('%Y-%m-%dT%H:%M:%f', ${date}, '${interval.replace('-', '+').replace(/(^\+|^)/, '-')}')`;
43+
}
44+
45+
addInterval(date, interval) {
46+
return `strftime('%Y-%m-%dT%H:%M:%f', ${date}, '${interval}')`;
47+
}
48+
49+
timeGroupedColumn(granularity, dimension) {
50+
return GRANULARITY_TO_INTERVAL[granularity](dimension);
51+
}
52+
53+
seriesSql(timeDimension) {
54+
const values = timeDimension.timeSeries().map(
55+
([from, to]) => `select '${from}' f, '${to}' t`
56+
).join(' UNION ALL ');
57+
return `SELECT dates.f date_from, dates.t date_to FROM (${values}) AS dates`;
58+
}
59+
}
60+
61+
module.exports = SqliteQuery;

packages/cubejs-server-core/core/index.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ const DriverDependencies = {
2323
snowflake: '@cubejs-backend/snowflake-driver',
2424
prestodb: '@cubejs-backend/prestodb-driver',
2525
oracle: '@cubejs-backend/oracle-driver',
26+
sqlite: '@cubejs-backend/sqlite-driver',
2627
};
2728

2829
const checkEnvForPlaceholders = () => {

packages/cubejs-sqlite-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.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<p align="center"><a href="https://cube.dev"><img src="https://i.imgur.com/zYHXm4o.png" alt="Cube.js" width="300px"></a></p>
2+
3+
[Website](https://cube.dev)[Docs](https://cube.dev/docs)[Blog](https://cube.dev/blog)[Slack](https://slack.cube.dev)[Twitter](https://twitter.com/thecubejs)
4+
5+
[![npm version](https://badge.fury.io/js/%40cubejs-backend%2Fserver.svg)](https://badge.fury.io/js/%40cubejs-backend%2Fserver)
6+
[![CircleCI](https://circleci.com/gh/cube-js/cube.js.svg?style=shield)](https://circleci.com/gh/cube-js/cube.js)
7+
8+
# Cube.js Sqlite Database Driver
9+
10+
Sqlite driver.
11+
12+
[Learn more](https://github.com/cube-js/cube.js#getting-started)
13+
14+
### License
15+
16+
Cube.js Sqlite Database Driver is [Apache 2.0 licensed](./LICENSE).
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
const sqlite3 = require('sqlite3');
2+
const BaseDriver = require('@cubejs-backend/query-orchestrator/driver/BaseDriver');
3+
4+
class SqliteDriver extends BaseDriver {
5+
constructor(config) {
6+
super();
7+
this.config = {
8+
database: process.env.CUBEJS_DB_NAME,
9+
...config
10+
};
11+
if (!this.config.db) {
12+
this.config.db = new sqlite3.Database(this.config.database);
13+
}
14+
}
15+
16+
async testConnection() {
17+
return this.query('SELECT 1');
18+
}
19+
20+
query(query, values) {
21+
return new Promise(
22+
(resolve, reject) => this.config.db.all(
23+
query,
24+
values || [],
25+
(err, result) => (err ? reject(err) : resolve(result))
26+
)
27+
);
28+
}
29+
30+
async release() {
31+
await new Promise((resolve, reject) => this.config.db.close((err) => (err ? reject(err) : resolve())));
32+
}
33+
34+
informationSchemaQuery() {
35+
return `
36+
SELECT name, sql
37+
FROM sqlite_master
38+
WHERE type='table'
39+
ORDER BY name
40+
`;
41+
}
42+
43+
async tablesSchema() {
44+
const query = this.informationSchemaQuery();
45+
46+
const tables = await this.query(query);
47+
48+
return {
49+
default: {
50+
...(tables.map(
51+
table => ({
52+
[table.name]: table.sql.match(/\((.*)\)/)[1].split(',')
53+
.map(nameAndType => nameAndType.trim().split(' ')).map(([name, type]) => ({ name, type }))
54+
})
55+
)).reduce((a, b) => ({ ...a, ...b }), {})
56+
}
57+
};
58+
}
59+
}
60+
61+
module.exports = SqliteDriver;

0 commit comments

Comments
 (0)