updated readme examples

README.md

@@ -79,24 +79,29 @@ All contributions are welcome, make sure to read the [contributing guideline](./
 
 ## Examples
 
-`nessie.config.ts`
+`nessie.config.ts` with all default values
 
 ```ts
-import { ClientPostgreSQL, nessieConfig } from "https://deno.land/x/nessie/mod.ts"; 
-
-const migrationFolder = "./migrations";
-
-const config: nessieConfig = {
-  client: new ClientPostgreSQL(migrationFolder, {
-    database: "nessie",
-    hostname: "localhost",
-    port: 5432,
-    user: "root",
-    password: "pwd",
-  }),
+import { ClientPostgreSQL } from "./clients/ClientPostgreSQL.ts";
+
+const nessieOptions = {
+  migrationFolder: "./db/migrations",
+  seedFolder: "./db/seeds",
+};
+
+const connectionOptions = {
+  database: "nessie",
+  hostname: "localhost",
+  port: 5432,
+  user: "root",
+  password: "pwd",
+};
+
+export default {
+  client: new ClientPostgreSQL(nessieOptions, connectionOptions),
+  exposeQueryBuilder: false,
 };
 
-export default config;
 ```
 
 Minimal example of a migration file
@@ -113,34 +118,30 @@ export const down: Migration = () => {
 };
 ```
 
-Using the native query builder
+Using the native query builder (`exposeQueryBuilder: true`)
 
 ```ts
 import { Migration } from "https://deno.land/x/nessie/mod.ts";
-import { Schema, dbDialects } from "https://deno.land/x/nessie/qb.ts";
+import { Schema } from "https://deno.land/x/nessie/qb.ts";
 
-const dialect: dbDialects = "mysql"
-
-export const up: Migration = () => {
-  const queryArray: string[] = new Schema(dialect).create("users", (table) => {
+export const up: Migration<Schema> = ({ queryBuilder }) => {
+  queryBuilder.create("users", (table) => {
     table.id();
     table.string("name", 100).nullable();
     table.boolean("is_true").default("false");
     table.custom("custom_column int default 1");
     table.timestamps();
   });
 
-  const queryString = new Schema(dialect).queryString(
+  queryBuilder.queryString(
     "INSERT INTO users VALUES (DEFAULT, 'Deno', true, 2, DEFAULT, DEFAULT);",
   )
 
-  queryArray.push(queryString);
-
-  return queryArray
+  return queryBuilder.query
 };
 
-export const down: Migration = () => {
-  return new Schema(dialect).drop("users");
+export const down: Migration<Schema> = ({ queryBuilder }) => {
+  return queryBuilder.drop("users");
 };
 ```
 

types.ts

@@ -8,7 +8,7 @@ export type Info<T = any> = {
 export type Migration<T = any> = (
   info: Info<T>,
 ) => string | string[] | Promise<string | string[]>;
-export type Seed = Migration;
+export type Seed = () => string | string[] | Promise<string | string[]>;
 export type LoggerFn = (output?: any, title?: string) => void;
 export type QueryWithString = (string: string) => string;
 export type AmountMigrateT = number | undefined;