Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add readonly option to Better-SQLite3 #5530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 25, 2023
Merged

Add readonly option to Better-SQLite3 #5530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a9764e3
Add readonly option to Better-SQLite3
undees Mar 28, 2023
40764a2
Run the commit hook's formatter on existing code
undees Mar 28, 2023
0ee2778
Check that Better-SQLite3 can prevent writes
undees Mar 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions lib/dialects/better-sqlite3/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ class Client_BetterSQLite3 extends Client_SQLite3 {

return new this.driver(this.connectionSettings.filename, {
nativeBinding: options.nativeBinding,
readonly: !!options.readonly,
});
}

Expand Down
4 changes: 4 additions & 0 deletions test/db-less-test-suite.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ if (config.mysql) {
require('./unit/dialects/mysql');
}

if (config['better-sqlite3']) {
require('./unit/dialects/better-sqlite3');
}

describe('CLI tests', function () {
this.timeout(process.env.KNEX_TEST_TIMEOUT || 5000);
require('./cli/help.spec');
Expand Down
63 changes: 60 additions & 3 deletions test/unit/dialects/better-sqlite3.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,18 @@ describe('better-sqlite3 unit tests', () => {
connection: {
filename: ':memory:',
options: {
nativeBinding: path.resolve(__dirname, '../../../node_modules/better-sqlite3/build/Release/better_sqlite3.node'),
nativeBinding: path.resolve(
__dirname,
'../../../node_modules/better-sqlite3/build/Release/better_sqlite3.node'
),
},
},
});

const result = await knexInstance.select(knexInstance.raw('2 + 2 as answer')).first().catch(err => err);
const result = await knexInstance
.select(knexInstance.raw('2 + 2 as answer'))
.first()
.catch((err) => err);
expect(result.answer).to.equal(4);
});

Expand All @@ -33,10 +39,61 @@ describe('better-sqlite3 unit tests', () => {
},
});

const result = await knexInstance.select(knexInstance.raw('2 + 2 as answer')).first().catch(err => err);
const result = await knexInstance
.select(knexInstance.raw('2 + 2 as answer'))
.first()
.catch((err) => err);
console.dir(result);
expect(result).to.be.an('error');
expect(result.code).to.equal('MODULE_NOT_FOUND');
});
});

describe('readonly', () => {
it('should initialize the DB with the passed-in `readonly` option', async () => {
const knexInstance = knex({
client: 'better-sqlite3',
useNullAsDefault: true,
connection: {
filename: __dirname + '/../test.sqlite3',
options: {
readonly: true,
},
},
});

const connection = await knexInstance.client.acquireConnection();
expect(connection.readonly).to.equal(true);
});

it('should prevent writing to the DB', async () => {
const knexInstance = knex({
client: 'better-sqlite3',
useNullAsDefault: true,
connection: {
filename: __dirname + '/../test.sqlite3',
options: {
readonly: true,
},
},
});

await expect(
knexInstance.raw('create table shouldFail (x integer)')
).to.eventually.be.rejectedWith('attempt to write a readonly database');
});

it('should fall back on `readonly` = `false`', async () => {
const knexInstance = knex({
client: 'better-sqlite3',
useNullAsDefault: true,
connection: {
filename: __dirname + '/../test.sqlite3',
},
});

const connection = await knexInstance.client.acquireConnection();
expect(connection.readonly).to.equal(false);
});
});
});
1 change: 1 addition & 0 deletions types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3055,6 +3055,7 @@ export declare namespace Knex {
filename: string;
options?: {
nativeBinding?: string;
readonly?: boolean;
};
}

Expand Down