Nim-Gatabase
API
- Postgres >= 10.
- UTF-8 encoding.
- All SQL are
const. - Database user must have a password.
- Database connection is to hostname.
- Self-Documentation Comments supported.
- Configurable AutoVacuum supported.
- Backups for Databases supported.
- The
timeoutargument is on Seconds. -
DISTINCTsupported on SQL,booltype,falseby default. -
LIMITsupported on SQL,inttype,int.highby default. -
OFFSETsupported on SQL,inttype,0by default. - No OS-specific code, so it should work on Linux, Windows and Mac.
- Compatible with
db_postgresand Ormin. - You can still use std lib
db_postgresas normal (same connection). - You can write with Gatabase and read with Ormin.
- Functional, all functions are
func(Effects free). - Debug raw SQL when not build for Release.
- Single file. 0 Dependency. Self-Documented.
- Run the module itself for an Example.
- Run
nim doc gatabase.nimfor more Documentation.
Fields
StringFieldInt8FieldInt16FieldInt32FieldIntFieldFloat32FieldFloatFieldBoolFieldPDocumentFieldColorFieldHashFieldHttpCodeFieldPegField
Use
import gatabase
# Database init (change to your user and password).
var database = Gatabase(user: "MyUserHere", password: "Passw0rd!", host: "localhost",
dbname: "database", port: 5432, timeout: 42)
database.connect()
# Engine
echo database.uri
echo database.getVersion()
echo database.getEnv()
echo database.getPid()
echo database.listAllUsers()
echo database.listAllDatabases()
echo database.listAllSchemas()
echo database.listAllTables()
echo database.getCurrentUser()
echo database.getCurrentDatabase()
echo database.getCurrentSchema()
echo database.getLoggedInUsers()
echo database.forceCommit()
echo database.forceRollback()
# Database
echo database.createDatabase("testing", "This is a Documentation Comment")
echo database.grantSelect("testing")
echo database.grantAll("testing")
echo database.renameDatabase("testing", "testing2")
echo database.getTop(3)
echo database.dropDatabase("testing2")
# User
echo database.createUser("pepe", "PaSsW0rD!", "This is a Documentation Comment")
echo database.changePasswordUser("pepe", "p@ssw0rd")
echo database.renameUser("pepe", "BongoCat")
echo database.dropUser("BongoCat")
# Schema
echo database.createSchema("memes", "This is a Documentation Comment", autocommit=false)
echo database.renameSchema("memes", "foo")
echo database.dropSchema("foo")
# Fields
let
a = newInt8Field(int8.high, "name0", "Help here", "Error here")
b = newInt16Field(int16.high, "name1", "Help here", "Error here")
c = newInt32Field(int32.high, "name2", "Help here", "Error here")
d = newIntField(int.high, "name3", "Help here", "Error here")
e = newFloat32Field(42.0.float32, "name4", "Help here", "Error here")
f = newFloatField(666.0.float64, "name5", "Help here", "Error here")
g = newBoolField(true, "name6", "Help here", "Error here")
# fails = newInt8Field(int64.high, "name9", "Input an int8", "Integer overflow error")
assert a is Field
assert b is Field
# Tables
echo database.createTable("table_name", fields = @[a, b, c, d, e, f, g],
"This is a Documentation Comment")
echo database.getAllRows("table_name", limit=255, offset=2, `distinct`=true)
echo database.searchColumns("table_name", "name0", $int8.high, 255)
echo database.changeAutoVacuumTable("table_name", true)
echo database.renameTable("table_name", "cats")
echo database.dropTable("cats")
# Backups
echo database.backupDatabase("database", "backup0.sql").output
echo database.backupDatabase("database", "backup1.sql", dataOnly=true, inserts=true).output
# db_postgres compatible (Raw Queries)
echo database.db.getRow(sql"SELECT current_database(); /* Still compatible with Std Lib */")
database.close()
# Check the Docs for more...Creating a Table with Fields:
echo database.createTable(tablename="table_name", fields = @[a, b, c, d, e, f, g], comment="This is a Documentation Comment", autocommit=true)Produces the SQL:
CREATE TABLE IF NOT EXISTS table_name(
id SERIAL PRIMARY KEY,
name0 smallint DEFAULT 127,
name1 smallint DEFAULT 32767,
name2 integer DEFAULT 2147483647,
name3 bigint DEFAULT 9223372036854775807,
name4 decimal DEFAULT 42.0,
name5 decimal DEFAULT 666.0,
name6 boolean DEFAULT true
); /* This is a Documentation Comment */
COMMENT ON TABLE table_name IS 'This is a Documentation Comment';Install
nimble install gatabase
FAQ
- Supports SQLite ?.
No.
- This is faster than ORMin ?.
No.
- I dont want to pass the Table name every time I use a function ?.
https://nim-lang.org/docs/manual.html#statements-and-expressions-using-statement
Requisites
- None.
(You need a working Postgres server up & running to use it, but not to install it)
Frontend
-
This ORM can run on the Browser.
nim js gatabase.nim
Since you can not run a full Postgres Server on the Browser, it returns the Raw SQL Query string instead of executing it. Just use Nims JavaScript target.
Example:
$ nim js -r gatabase.nim
Hint: /usr/bin/node nimcache/gatabase.js [Exec]
SHOW SERVER_VERSION;
SHOW ALL;
select pg_backend_pid();
SELECT rolname FROM pg_roles;
SELECT nspname FROM pg_catalog.pg_namespace;
SELECT tablename FROM pg_catalog.pg_tables;
SELECT current_user;
SELECT current_database();
select current_schema();
GRANT SELECT ON testing TO PUBLIC;
GRANT ALL PRIVILEGES ON DATABASE testing TO PUBLIC;
ALTER DATABASE testing RENAME TO testing2;
SELECT * FROM current_database() LIMIT 3 OFFSET 0;
DROP DATABASE IF EXISTS testing2;
ALTER USER pepe RENAME TO pepe2;
DROP USER IF EXISTS pepe2;
CREATE SCHEMA IF NOT EXISTS memes;
ALTER SCHEMA memes RENAME TO foo;
DROP SCHEMA IF EXISTS foo CASCADE;
CREATE TABLE IF NOT EXISTS table_name(
id SERIAL PRIMARY KEY,
name0 smallint DEFAULT 127,
name1 smallint DEFAULT 32767,
name2 integer DEFAULT 2147483647,
name3 bigint DEFAULT 2147483647,
name4 decimal DEFAULT 42,
name5 decimal DEFAULT 666,
name6 boolean DEFAULT true); /* This is a Documentation Comment */
select distinct * from table_name limit 255 offset 2;
ALTER TABLE table_name RENAME TO cats;
DROP TABLE IF EXISTS cats CASCADE;Alternatives
- For a faster but lower-level ORM see ORMin. (DSL ORM, Raw SQL Performance, can expose your database fields via JSON WebSockets automagically)
