This package is deprecated and, most probably, no longer functioning due to changes in packages it depends on. Please use simple-sql-query-builder instead.
An SQL query builder for RN projects. It executes built queries if an executing function is set.
This is the "entry point" of the builder. It contains only static
methods and fields.
import SqlBuilder from "react-native-sql-query-builder";
-
Turns on or off the debug mode. In debug mode each executed sql statement is logged to the console.
SqlBuilder.setDebug(debug);
-
Sets a function to be used to execute sql statements.
import SQLite from "react-native-sqlite-storage"; ... const db = await SQLite.openDatabase(...); SqlBuilder.setSqlExecutor(db.executeSql.bind(db));
-
Executes an sql statement by invoking a function set by
setSqlExecutor()
. It returns the result of that function invocation or simply the passed sql statement ifsetSqlExecutor
hasn't been called.The result of invoking this method is returned from the CRUD methods.
SqlBuilder.executeSql("some sql code);
-
Creates a table using TableBuilder.
const name = "weights"; const callback = tableBuilder => { tb.integer("rowid").primary(); tb.integer("millis").notNull(); tb.integer("gross").notNull(); tb.integer("net").notNull(); tb.text("comment").notNull(); }; const ifNotExists = Boolean; // Adds "IF NOT EXISTS" if true. Default: true. SqlBuilder.createTable(name, callback, ifNotExists);
-
column()
Creates a Column and returns it to allow method chaining.
tb .column( name: "rate", type: "REAL") .notNull();
There are shorthands for the
INTEGER
,TEXT
andBLOB
types:tb.integer("rowid").primary(); tb.text("comment").notNull(); tb.blob("image");
-
unique()
Makes a column unique using UniqueBuilder.
tb.unique(ub => { ub .column("name") .collate("NOCASE") .order("ASC"); ub .column("code") .collate("NOCASE") .order("ASC"); });
-
primary()
Adds
PRIMARY KEY
to this column definition. -
foreign()
Adds
REFERENCES tableName(columnName)
to this column definition.tb.integer("type").foreign("tableName", "columnName");
-
onDelete()
Adds
ON DELETE action
to this column definition.tb.integer("journeyRowid") .foreign("tableName", "column name") .onDelete("action");
-
notNull()
Adds
NOT NULL
to this column definition.
-
column()
Specifies the unique column name and optionally collation and order.
ub .column("code") .collate("NOCASE") .order("ASC");
Version number | Changes |
---|---|
v1.0.0 | Initial release. |
|
Written with StackEdit.