@ghom/orm 1.7.1 → 1.7.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ghom/orm",
-  "version": "1.7.1",
+  "version": "1.7.2",
   "license": "MIT",
   "type": "module",
   "main": "dist/esm/index.js",

package/readme.md

@@ -22,9 +22,12 @@ const orm = new ORM({
   logger: console,
   loggerColors: { ... }
 })
+
+// start handling of tables
+await orm.init()
 ```
 
-## Tables
+## Add tables
 
 The tables are automatically loaded from the `location` directory.
 
@@ -33,7 +36,12 @@ The tables are automatically loaded from the `location` directory.
 
 import { Table } from "@ghom/orm"
 
-export default new Table({
+interface User {
+  username: string
+  password: string
+}
+
+export default new Table<User>({
   name: "user",
   
   // the higher the priority, the earlier the table is compiled
@@ -59,20 +67,30 @@ export default new Table({
 })
 ```
 
-## Query
+## Launch a query
 
-For more information about the query builder, see [knexjs.org](https://knexjs.org/).
+For more information about the query builder, see [knexjs.org](https://knexjs.org/).  
+You can launch a SQL query on a table like that
 
-## Import/extract
+```typescript
+import user from "./tables/user"
 
-You can transfer the data from one instance of the ORM to another (between two database clients, for example between "pg" and "mysql2").
+export async function compareHash(username, hash): Promise<boolean> {
+  const user = await user.query
+    .select()
+    .where("username", username)
+    .first()
 
-```typescript
-await orm1.extract()
+  return user && user.password === hash
+}
 ```
 
-```typescript
-await orm2.import()
-```
+## Future features
 
-The SQL structure isn't transferred, only the data. You must copy the table files to the other project.
+- [ ] Take full control of the table creation
+- [ ] Add backup option
+- [ ] Add admin panel
+- [ ] Add shortcuts for advanced relative queries
+- [ ] Add timed caching system
+- [ ] Make possible to switch the data between all possible clients (pg, mysql, sqlite3)
+- [ ] Add a way to set up timezone directly in the ORM constructor