This commit is contained in:
Nybkox
2025-01-23 15:46:15 +01:00
parent 645a1d35e8
commit bcf89b1f09
33 changed files with 832 additions and 87 deletions

View File

@@ -0,0 +1,6 @@
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![NPM version](https://img.shields.io/npm/v/dbgate-plugin-cassandra.svg)](https://www.npmjs.com/package/dbgate-plugin-cassandra)
# dbgate-plugin-cassandra
Use DbGate for install of this plugin

View File

@@ -0,0 +1,35 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- Generator: Adobe Illustrator 19.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<svg version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
viewBox="0 0 384 384" style="enable-background:new 0 0 384 384;" xml:space="preserve">
<polygon style="fill:#EFEEEE;" points="64,0 64,384 288,384 384,288 384,0 "/>
<polygon style="fill:#ABABAB;" points="288,288 288,384 384,288 "/>
<polygon style="fill:#DEDEDD;" points="192,384 288,384 288,288 "/>
<path style="fill:#448E47;" d="M0,96v112h256V96L0,96L0,96z"/>
<g>
<path style="fill:#FFFFFF;" d="M64.32,130.112c-1.184-2.288-3.344-3.424-6.48-3.424c-1.728,0-3.152,0.464-4.272,1.408
c-1.12,0.928-2,2.416-2.64,4.496s-1.088,4.8-1.344,8.176c-0.272,3.36-0.384,7.472-0.384,12.336c0,5.184,0.176,9.376,0.528,12.576
c0.336,3.2,0.896,5.664,1.632,7.44s1.664,2.96,2.784,3.552c1.12,0.608,2.416,0.928,3.888,0.928c1.216,0,2.352-0.208,3.408-0.624
s1.968-1.248,2.736-2.496c0.784-1.248,1.392-3.008,1.824-5.28c0.448-2.272,0.672-5.264,0.672-8.976H80.48
c0,3.696-0.288,7.232-0.864,10.56s-1.664,6.24-3.216,8.736c-1.584,2.48-3.776,4.432-6.624,5.84
c-2.848,1.408-6.544,2.128-11.088,2.128c-5.168,0-9.312-0.848-12.368-2.496c-3.072-1.664-5.424-4.064-7.056-7.2
s-2.688-6.88-3.168-11.232c-0.464-4.336-0.72-9.152-0.72-14.384c0-5.184,0.256-9.968,0.72-14.352
c0.48-4.368,1.552-8.144,3.168-11.28c1.648-3.12,3.984-5.584,7.056-7.344c3.056-1.744,7.2-2.64,12.368-2.64
c4.944,0,8.816,0.8,11.664,2.4c2.848,1.6,4.976,3.632,6.368,6.096s2.304,5.12,2.64,7.968c0.352,2.848,0.528,5.52,0.528,8.016H66.08
C66.08,136,65.488,132.368,64.32,130.112z"/>
<path style="fill:#FFFFFF;" d="M109.072,167.008c0,1.6,0.144,3.056,0.384,4.352c0.272,1.312,0.736,2.416,1.44,3.312
c0.704,0.912,1.664,1.616,2.848,2.128c1.168,0.496,2.672,0.768,4.448,0.768c2.128,0,4.016-0.688,5.712-2.064
c1.68-1.376,2.544-3.52,2.544-6.384c0-1.536-0.224-2.864-0.624-3.984c-0.416-1.12-1.104-2.128-2.064-3.008
c-0.976-0.912-2.24-1.712-3.792-2.448s-3.504-1.488-5.808-2.256c-3.056-1.024-5.712-2.16-7.968-3.376
c-2.24-1.2-4.112-2.624-5.616-4.272c-1.504-1.632-2.608-3.52-3.312-5.664c-0.704-2.16-1.056-4.624-1.056-7.456
c0-6.784,1.888-11.824,5.664-15.152c3.76-3.328,8.96-4.992,15.552-4.992c3.072,0,5.904,0.336,8.496,1.008s4.832,1.744,6.72,3.264
c1.888,1.504,3.36,3.424,4.416,5.744c1.04,2.336,1.584,5.136,1.584,8.4v1.92h-13.232c0-3.264-0.576-5.776-1.712-7.552
c-1.152-1.744-3.072-2.64-5.76-2.64c-1.536,0-2.816,0.24-3.84,0.672c-1.008,0.448-1.84,1.04-2.448,1.776s-1.04,1.616-1.264,2.576
c-0.24,0.96-0.336,1.952-0.336,2.976c0,2.128,0.448,3.888,1.344,5.328c0.896,1.456,2.816,2.784,5.76,3.984l10.656,4.608
c2.624,1.152,4.768,2.352,6.416,3.616c1.664,1.248,3.008,2.592,3.984,4.032c0.992,1.44,1.68,3.008,2.064,4.752
c0.384,1.712,0.576,3.648,0.576,5.744c0,7.232-2.096,12.496-6.288,15.792c-4.192,3.296-10.032,4.96-17.52,4.96
c-7.808,0-13.392-1.696-16.768-5.088c-3.36-3.392-5.024-8.256-5.024-14.592v-2.784h13.824L109.072,167.008L109.072,167.008z"/>
<path style="fill:#FFFFFF;" d="M177.344,168.544h0.304l10.176-50.688h14.32L186.4,186.4h-17.76l-15.728-68.544h14.784
L177.344,168.544z"/>
</g>
</svg>

After

Width:  |  Height:  |  Size: 3.1 KiB

View File

@@ -0,0 +1,38 @@
{
"name": "dbgate-plugin-cassandra",
"main": "dist/backend.js",
"version": "6.0.0-alpha.1",
"license": "GPL-3.0",
"author": "Jan Prochazka",
"description": "cassandra connector for DbGate",
"keywords": [
"dbgate",
"cassandra",
"dbgatebuiltin"
],
"files": [
"dist",
"icon.svg"
],
"scripts": {
"build:frontend": "webpack --config webpack-frontend.config",
"build:frontend:watch": "webpack --watch --config webpack-frontend.config",
"build:backend": "webpack --config webpack-backend.config.js",
"build": "yarn build:frontend && yarn build:backend",
"plugin": "yarn build && yarn pack && dbgate-plugin dbgate-plugin-cassandra",
"plugout": "dbgate-plugout dbgate-plugin-cassandra",
"copydist": "yarn build && yarn pack && dbgate-copydist ../dist/dbgate-plugin-cassandra",
"prepublishOnly": "yarn build"
},
"devDependencies": {
"dbgate-plugin-tools": "^1.0.8",
"webpack": "^5.91.0",
"webpack-cli": "^5.1.4"
},
"dependencies": {
"dbgate-tools": "^6.0.0-alpha.1",
"json-stable-stringify": "^1.0.1",
"lodash": "^4.17.21",
"cassandra-driver": "^4.7.2"
}
}

View File

@@ -0,0 +1,8 @@
module.exports = {
trailingComma: 'es5',
tabWidth: 2,
semi: true,
singleQuote: true,
arrowParen: 'avoid',
printWidth: 120,
};

View File

@@ -0,0 +1,60 @@
const { DatabaseAnalyser } = global.DBGATE_PACKAGES['dbgate-tools'];
const sql = require('./sql');
class Analyser extends DatabaseAnalyser {
constructor(connection, driver) {
super(connection, driver);
}
createQuery(resFileName, typeFields, replacements = {}) {
let res = sql[resFileName];
res = res.replace('#DATABASE#', this.dbhan.database);
return super.createQuery(res, typeFields, replacements);
}
async _runAnalysis() {
this.feedback({ analysingMessage: 'Loading tables' });
const tables = await this.analyserQuery('tables', ['tables']);
this.feedback({ analysingMessage: 'Loading columns' });
const columns = await this.analyserQuery('columns', ['tables']);
// this.feedback({ analysingMessage: 'Loading views' });
// const views = await this.analyserQuery('views', ['views']);
const res = {
tables: tables.rows.map((table) => {
const tableColumns = columns.rows.filter((col) => col.pureName == table.pureName);
const pkColumns = tableColumns.filter((i) => i.kind === 'partition_key' || i.kind === 'clustering');
return {
...table,
primaryKeyColumns: pkColumns,
columns: tableColumns,
primaryKey: pkColumns.length ? { columns: pkColumns } : null,
foreignKeys: [],
};
}),
views: [],
functions: [],
triggers: [],
};
this.feedback({ analysingMessage: null });
return res;
}
async singleObjectAnalysis(dbhan, typeField) {
const structure = await this._runAnalysis(dbhan, typeField);
const item = structure[typeField]?.find((i) => i.pureName === dbhan.pureName);
return item;
}
// async _computeSingleObjectId() {
// const { pureName } = this.singleObjectFilter;
// const resId = await this.driver.query(
// this.dbhan,
// `SELECT uuid as id FROM system.tables WHERE database = '${this.dbhan.database}' AND name='${pureName}'`
// );
// this.singleObjectId = resId.rows[0]?.id;
// }
}
module.exports = Analyser;

View File

@@ -0,0 +1,84 @@
const { createBulkInsertStreamBase } = global.DBGATE_PACKAGES['dbgate-tools'];
/**
*
* @param {import('dbgate-types').TableInfo} tableInfo
* @param {string} columnName
* @returns {{columnName: string, dataType: string} | null}
*/
function getColumnInfo(tableInfo, columnName) {
const column = tableInfo.columns.find((x) => x.columnName == columnName);
if (!column) return null;
return {
columnName,
dataType: column.dataType,
};
}
/**
*
* @param {string} tableName
* @returns {import('dbgate-types').TableInfo | null}
*/
/**
* @param {string} tableName
* @returns {{ shouldAddUuidPk: true, pkColumnName: string } | { shouldAddUuidPk: false }}
*/
function getShouldAddUuidPkInfo(tableInfo) {
const pkColumnName = tableInfo.primaryKey?.columns[0]?.columnName;
if (!pkColumnName) return { shouldAddUuidPk: true, pkColumnName: 'id' };
const columnInfo = getColumnInfo(tableInfo, pkColumnName);
if (!columnInfo || columnInfo.dataType.toLowerCase() !== 'uuid') return { shouldAddUuidPk: false };
const shouldAddUuidPk = writable.columnNames.every((i) => i !== columnInfo.columnName);
if (!shouldAddUuidPk) return { shouldAddUuidPk };
return { shouldAddUuidPk, pkColumnName };
}
/**
*
* @param {import('dbgate-types').EngineDriver<import('cassandra-driver').Client>} driver
* @param {import('stream')} stream
* @param {import('dbgate-types').DatabaseHandle<import('cassandra-driver').Client>} dbhan
* @param {import('dbgate-types').NamedObjectInfo} name
* @param {import('dbgate-types').WriteTableOptions} option
*/
function createCassandraBulkInsertStream(driver, stream, dbhan, name, options) {
const writable = createBulkInsertStreamBase(driver, stream, dbhan, name, options);
writable.send = async () => {
const { shouldAddUuidPk, pkColumnName } = getShouldAddUuidPkInfo(writable.structure);
const rows = writable.buffer;
const fullNameQuoted = writable.fullNameQuoted;
writable.buffer = [];
for (const row of rows) {
const dmp = driver.createDumper();
dmp.putRaw(`INSERT INTO ${fullNameQuoted} (`);
if (shouldAddUuidPk) {
dmp.putRaw(driver.dialect.quoteIdentifier(pkColumnName));
dmp.putRaw(', ');
}
dmp.putCollection(',', writable.columnNames, (col) => dmp.putRaw(driver.dialect.quoteIdentifier(col)));
dmp.putRaw(')\n VALUES\n');
dmp.putRaw('(');
if (shouldAddUuidPk) {
dmp.putRaw('uuid()');
dmp.putRaw(', ');
}
dmp.putCollection(',', writable.columnNames, (col) => dmp.putValue(row[col]));
dmp.putRaw(')');
await driver.query(dbhan, dmp.s, { discardResult: true });
}
};
return writable;
}
module.exports = createCassandraBulkInsertStream;

View File

@@ -0,0 +1,162 @@
const _ = require('lodash');
const stream = require('stream');
const driverBase = require('../frontend/driver');
const Analyser = require('./Analyser');
const cassandra = require('cassandra-driver');
const createCassandraBulkInsertStream = require('./createBulkInsertStream.js');
function getTypeName(code) {
return Object.keys(cassandra.types.dataTypes).find((key) => cassandra.types.dataTypes[key] === code);
}
/** @type {import('dbgate-types').EngineDriver<cassandra.Client>} */
const driver = {
...driverBase,
analyserClass: Analyser,
// creating connection
async connect({ server, port, user, password, database, localDataCenter, useDatabaseUrl, databaseUrl }) {
console.log('#conn', localDataCenter);
const client = new cassandra.Client({
// port,
// user,
// password,
contactPoints: server.split(','),
localDataCenter: localDataCenter ?? this.defaultLocalDataCenter,
keyspace: database,
});
client.connect();
return {
client,
database,
};
},
// called for retrieve data (eg. browse in data grid) and for update database
async query(dbhan, query, options) {
const offset = options?.range?.offset;
if (options?.discardResult) {
await dbhan.client.execute(query);
return {
rows: [],
columns: [],
};
}
const result = await dbhan.client.execute(query);
if (!result.rows?.[0]) {
return {
rows: [],
columns: [],
};
}
const columns = result.columns.map(({ name, type: { code } }) => ({
columnName: name,
dataType: getTypeName(code),
}));
return {
rows: offset ? result.rows.slice(offset) : result.rows,
columns,
};
},
// called in query console
async stream(dbhan, query, options) {
try {
if (!query.match(/^\s*SELECT/i)) {
await dbhan.client.execute(query);
options.done();
return;
}
const strm = dbhan.client.stream(query);
strm.on('readable', () => {
let row;
while ((row = strm.read())) {
options.row(row);
}
});
strm.on('end', () => {
options.done();
});
strm.on('error', (err) => {
options.info({
message: err.toString(),
time: new Date(),
severity: 'error',
});
options.done();
});
} catch (err) {
const mLine = err.message.match(/\(line (\d+)\,/);
let line = undefined;
if (mLine) {
line = parseInt(mLine[1]) - 1;
}
options.info({
message: err.message,
time: new Date(),
severity: 'error',
line,
});
options.done();
}
},
// called when exporting table or view
async readQuery(dbhan, query, structure) {
const pass = new stream.PassThrough({
objectMode: true,
highWaterMark: 100,
});
const strm = dbhan.client.stream(query);
strm.on('readable', () => {
let row;
while ((row = strm.read())) {
pass.write(row);
}
});
strm.on('end', () => {
pass.end();
});
strm.on('error', (err) => {
pass.info({
message: err.toString(),
time: new Date(),
severity: 'error',
});
pass.end();
});
return pass;
},
async writeTable(dbhan, name, options) {
return createCassandraBulkInsertStream(this, stream, dbhan, name, options);
},
// detect server version
async getVersion(dbhan) {
const result = await dbhan.client.execute('SELECT release_version from system.local');
return { version: result.rows[0].release_version };
},
// list databases on server
async listDatabases(dbhan) {
const result = await dbhan.client.execute(
"SELECT keyspace_name FROM system_schema.keyspaces WHERE keyspace_name >= 'system' ALLOW FILTERING"
);
return result.rows.map((row) => ({ name: row.keyspace_name }));
},
async close(dbhan) {
return dbhan.client.shutdown();
},
};
module.exports = driver;

View File

@@ -0,0 +1,6 @@
const driver = require('./driver');
module.exports = {
packageName: 'dbgate-plugin-cassandra',
drivers: [driver],
};

View File

@@ -0,0 +1,9 @@
module.exports = `
SELECT
table_name as "pureName",
column_name as "columnName",
type as "dataType",
kind as "kind"
FROM system_schema.columns
WHERE keyspace_name = '#DATABASE#'
`;

View File

@@ -0,0 +1,9 @@
const columns = require('./columns');
const tables = require('./tables');
const views = require('./views');
module.exports = {
columns,
tables,
views,
};

View File

@@ -0,0 +1,5 @@
module.exports = `
SELECT table_name as "pureName"
FROM system_schema.tables
WHERE keyspace_name='#DATABASE#';
`;

View File

@@ -0,0 +1,10 @@
module.exports = `
select
tables.name as "pureName",
tables.uuid as "objectId",
views.view_definition as "viewDefinition",
tables.metadata_modification_time as "contentHash"
from information_schema.views
inner join system.tables on views.table_name = tables.name and views.table_schema = tables.database
where views.table_schema='#DATABASE#' and tables.uuid =OBJECT_ID_CONDITION
`;

View File

@@ -0,0 +1,27 @@
/**
* @type {{ SqlDumper: import('dbgate-types').SqlDumper}}
*/
const { SqlDumper } = global.DBGATE_PACKAGES['dbgate-tools'];
class Dumper extends SqlDumper {
/**
* @param {import('dbgate-types').ColumnInfo} column
* @param {string} newName
*
* @returns {void}
*/
renameColumn(column, newName) {
this.putCmd('^alter ^table %f ^rename %i ^to %i', column, column.columnName, newName);
}
/**
* @param {import('dbgate-types').ColumnInfo} column
*
* @returns {void}
*/
dropColumn(column) {
this.putCmd('^alter ^table %f ^drop %i', column, column.columnName);
}
}
module.exports = Dumper;

View File

@@ -0,0 +1,117 @@
const { driverBase } = global.DBGATE_PACKAGES['dbgate-tools'];
const Dumper = require('./Dumper');
const { mysqlSplitterOptions } = require('dbgate-query-splitter/lib/options');
const _cloneDeepWith = require('lodash/cloneDeepWith');
/** @type {import('dbgate-types').SqlDialect} */
const dialect = {
limitSelect: true,
rangeSelect: true,
rawUuids: true,
stringEscapeChar: "'",
fallbackDataType: 'varchar',
offsetNotSupported: true,
allowMultipleValuesInsert: false,
createColumn: true,
dropColumn: true,
changeColumn: true,
changeAutoIncrement: true,
createIndex: true,
dropIndex: true,
anonymousPrimaryKey: true,
createColumnWithColumnKeyword: true,
specificNullabilityImplementation: true,
omitForeignKeys: true,
omitUniqueConstraints: true,
omitIndexes: true,
omitTableAliases: true,
omitTableBeforeColumn: true,
sortingKeys: true,
predefinedDataTypes: [
'custom',
'ascii',
'bigint',
'blob',
'boolean',
'counter',
'decimal',
'double',
'float',
'int',
'text',
'timestamp',
'uuid',
'varchar',
'varint',
'timeuuid',
'inet',
'date',
'time',
'smallint',
'tinyint',
'duration',
'list',
'map',
'set',
'udt',
'tuple',
],
disableAutoIncrement: true,
disableNonPrimaryKeyRename: true,
defaultNewTableColumns: [
{
columnName: 'id',
dataType: 'uuid',
notNull: true,
},
],
columnProperties: {
columnComment: true,
},
quoteIdentifier(s) {
return `"${s}"`;
},
};
/** @type {import('dbgate-types').EngineDriver} */
const driver = {
...driverBase,
supportsTransactions: false,
defaultPort: 9042,
defaultLocalDataCenter: 'datacenter1',
dumperClass: Dumper,
dialect,
engine: 'cassandra@dbgate-plugin-cassandra',
title: 'Cassandra',
showConnectionField: (field, values) =>
['server', 'port', 'singleDatabase', 'localDataCenter', 'isReadOnly', 'user', 'password'].includes(field),
getQuerySplitterOptions: (usage) =>
usage == 'editor'
? { ...mysqlSplitterOptions, ignoreComments: true, preventSingleLineSplit: true }
: mysqlSplitterOptions,
adaptTableInfo(table) {
if (!table.primaryKey && !table.sortingKey) {
return {
...table,
primaryKey: {
columns: [
{
columnName: 'id',
},
],
},
columns: [
{
columnName: 'id',
dataType: 'uuid',
},
...table.columns,
],
};
}
return table;
},
};
module.exports = driver;

View File

@@ -0,0 +1,6 @@
import driver from './driver';
export default {
packageName: 'dbgate-plugin-cassandra',
drivers: [driver],
};

View File

@@ -0,0 +1,29 @@
var webpack = require('webpack');
var path = require('path');
const packageJson = require('./package.json');
const buildPluginExternals = require('../../common/buildPluginExternals');
const externals = buildPluginExternals(packageJson);
var config = {
context: __dirname + '/src/backend',
entry: {
app: './index.js',
},
target: 'node',
output: {
path: path.resolve(__dirname, 'dist'),
filename: 'backend.js',
libraryTarget: 'commonjs2',
},
// uncomment for disable minimalization
// optimization: {
// minimize: false,
// },
externals,
};
module.exports = config;

View File

@@ -0,0 +1,24 @@
var webpack = require("webpack");
var path = require("path");
var config = {
context: __dirname + "/src/frontend",
entry: {
app: "./index.js",
},
target: "web",
output: {
path: path.resolve(__dirname, "dist"),
filename: "frontend.js",
libraryTarget: "var",
library: 'plugin',
},
// uncomment for disable minimalization
// optimization: {
// minimize: false,
// },
};
module.exports = config;