Installations

npm install @fxjs/sql-ddl-sync

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

18.18.2

NPM Version

lerna/5.5.4/node@v18.18.2+x64 (win32)

Pull Requests

Open

1

Total

42

Closed

2

Merged

39

Issues

Open

5

Total

6

Closed

1

Releases

4

Synchronous query first ORM!

v1.10.0

Updated on Apr 25, 2019

v1.10.0-alpha.1

Updated on Apr 25, 2019

v1.10.0-alpha

Updated on Apr 25, 2019

Fix bad implementation in past two MINOR versions

v1.9.8

Updated on Apr 16, 2019

View All 4 releases

Languages

2

JavaScript

TypeScript

JavaScript (56.95%)

TypeScript (43.05%)

Developer

fxjs-modules

Download Statistics

Total Downloads

42,555

Last Day

3

Last Week

84

Last Month

151

Last Year

2,438

GitHub Statistics

MIT License

3 Stars

570 Commits

5 Forks

6 Watchers

17 Branches

7 Contributors

Updated on Apr 19, 2025

Maintainers

2

View All 7 Contributors

Package Meta Information

Latest Version

0.11.7

Package Id

@fxjs/sql-ddl-sync@0.11.7

Unpacked Size

106.97 kB

Size

17.78 kB

File Count

29

NPM Version

lerna/5.5.4/node@v18.18.2+x64 (win32)

Node Version

18.18.2

Published on

Apr 19, 2025

Total Downloads

Cumulative downloads

Total Downloads

42,555

Last Day

200%

3

Compared to previous day

Last Week

281.8%

84

Compared to previous week

Last Month

-31.7%

151

Compared to previous month

Last Year

-17.8%

2,438

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

3

@fxjs/orm-core @fxjs/orm-property @fxjs/sql-query

Peer Dependencies

2

@fxjs/db-driver @fxjs/orm-core

Dev Dependencies

9

@fibjs/types @fxjs/db-driver cross-env fib-pool fib-rollup fib-typify rimraf rollup-plugin-commonjs should

Fibjs SQL DDL Synchronization

NOTICE: This is node-sql-ddl-sync's fibjs version, thx a lot to node-sql-ddl-sync's author : )

Install

1npm install @fxjs/sql-ddl-sync

Dialects

MySQL
SQLite

About

Originally, this module is part of @fxjs/orm. It's used synchronize model tables in supported dialects.

But now, it could run without @fxjs/orm, just install @fxjs/db-driver instead 🚀 Sorry there is no API documentation for now but there are a couple of tests you can read and find out how to use it if you want.

Version Match

`sql-ddl-sync` Version	required `orm` Version
sql-ddl-sync <= 0.3.x	orm < 1.10.3
sql-ddl-sync = 0.4.x	orm >= 1.10.3
sql-ddl-sync >= 0.5.x	don't need!

Example

Install @fxjs/db-driver. Create a file with the contents below and change insert your database credentials. Run once and you'll see table ddl_sync_test appear in your database. Then make some changes to it (add/drop/change columns) and run the code again. Your table should always return to the same structure.

1const DBDriver   = require("@fxjs/db-driver");
2const mysql = require("mysql");
3const Sync  = require("@fxjs/sql-ddl-sync").Sync;
4
5const dbdriver = DBDriver.create("mysql://username:password@localhost/database");
6
7const sync = new Sync({
8	dbdriver: dbdriver,
9	debug   : function (text) {
10		console.log("> %s", text);
11	}
12});
13
14sync.defineCollection("ddl_sync_test", {
15	id     : { type: "serial", key: true, serial: true },
16	name   : { type: "text", required: true },
17	age    : { type: "integer" },
18	male   : { type: "boolean" },
19	born   : { type: "date", time: true },
20	born2  : { type: "date" },
21	int2   : { type: "integer", size: 2 },
22	int4   : { type: "integer", size: 4 },
23	int8   : { type: "integer", size: 8 },
24	float4 : { type: "number",  size: 4 },
25	float8 : { type: "number",  size: 8 },
26	photo  : { type: "binary" }
27});
28
29try {
30	sync.sync()
31	console.log("> Sync Done");
32} catch (err) {
33	if (err) {
34		console.log("> Sync Error");
35		console.log(err);
36	}
37}
38
39process.exit(0);

Test

To test, first make sure you have development dependencies installed. Go to the root folder and do:

1npm install

Then, just run the tests.

1npm test

If you have a supported database server and want to test against it, first install the module:

And then run:

1URI=mysql://username:password@localhost/database fibjs test/run-db

Credits

This repo is checked out from Diogo Resende's node-sql-ddl-sync, which is one part of orm, and orm is the original source of @fxjs/orm. Thx a lot to him and his partner.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

2

Maintained

Determines if the project is "actively maintained".

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

4.3

/10

Last Scanned on 2025-06-30

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More