moving docs

Author: akrouk

README.md

@@ -20,31 +20,4 @@ db.close();
 
 ***This module is still a work in progress.***
 
-By design, it was created as an SQL backend for interaction-based Discord bots built in [discord.js v13](https://discord.js.org/#/docs/discord.js/v13/general/welcome). It is intended to create more user-friendly, asynchronous query functions, which take in an "options" object as arguments, a practice inspired by discord.js. 
-
-While it can run any query asychronously, it currently only supports the following built-in query and expression functions:
-
-## Queries
-
-### Insert
-`insert({ table: string, columns?: string[], values: string[])`
-```javascript
-const id = '123456789';
-const username = 'user99';
-
-await db.insert({
-  table: 'users',
-  columns: [ 'id', 'username' ],
-  values: [ id, username ]
-});
-```
-
-### Select
-### Update
-### Delete
-## Expressions
-  - Boolean
-  - Aggregate
-
-## Future plans
-Presently, there are no plans to add functionality such as creating tables, attaching databases, etc. For now, I handle operations like that with [DB Browser](https://sqlitebrowser.org/), which is a great tool for managing tables and data in small SQLite3 databases.
+By design, it was created as an SQL backend for interaction-based Discord bots built in [discord.js v13](https://discord.js.org/#/docs/discord.js/v13/general/welcome). It is intended to create more user-friendly, asynchronous query functions, which take in an "options" object as arguments, a practice inspired by discord.js. 

docs/DOCS.md

@@ -0,0 +1,38 @@
+While it can run any query asychronously, it currently only supports the following built-in query and expression functions:
+
+## Queries
+
+### Base Options
+`{ file?: string, table?: string }`
+
+Any query can be run with the `file` option, which represents the relative path to a database file. The database will be accessed dynamically during the query and will only remain open until its resolution. This is ideal for avoiding the clutter of synchronously accessing a database when only a single query needs to be run.
+
+```javascript
+// No need to call db.open('./database.db') or db.close(). This query will handle that itself!
+const data = await db.select({ file: './database.db', all: true, from: 'table' }); 
+```
+
+### Insert
+`insert({ into: string, columns?: string[], values: string[] })`
+
+```javascript
+var id = '123456789';
+var username = 'user99';
+
+await db.insert({
+  into: 'users',
+  columns: [ 'id', 'username' ],
+  values: [ id, username ]
+});
+```
+
+### Select
+### Update
+### Delete
+
+## Expressions
+  - Boolean
+  - Aggregate
+
+## Future plans
+Presently, there are no plans to add functionality such as creating tables, attaching databases, etc. For now, I handle operations like that with [DB Browser](https://sqlitebrowser.org/), which is a great tool for managing tables and data in small SQLite3 databases.

index.d.ts

@@ -8,6 +8,7 @@ type QueryPromise = Promise<QueryRetval>;
 
 interface BaseOptions {
     file?: string,
+    table?: string
 }
 
 interface RunOptions extends BaseOptions {
@@ -16,7 +17,7 @@ interface RunOptions extends BaseOptions {
 }
 
 interface InsertOptions extends BaseOptions {
-    table: string,
+    into: string,
     columns?: string[],
     values: string[]
 }
@@ -39,7 +40,7 @@ interface UpdateOptions extends BaseOptions {
 }
 
 interface DeleteOptions extends BaseOptions {
-    table: string,
+    from: string,
     where?: (string | Expression)[]
 }
 

lib/queries.js

@@ -47,6 +47,10 @@ module.exports = {
     // Export database open/close functions (synchronous!)
     open, close,
 
+    print: function() {
+        console.log(typeof db);
+    },
+
     /**
      * Asynchronous database query.
      * @param {RunOptions} options SQL statement

util/sqlstr.js

@@ -8,10 +8,10 @@ module.exports = {
      * @returns {string}
      */
      insertStr: function(options) {
-        if (!options.table || !options.values)
+        if (!(options.table || options.into) || !options.values)
             throw new Error('No table or values specified.');
 
-        let stmt = `INSERT INTO ${options.table}`;
+        let stmt = `INSERT INTO ${options.table ?? options.into}`;
 
         if (options.columns)
             stmt += ` (${parseColumns(options.columns)})`;
@@ -29,13 +29,13 @@ module.exports = {
         if (!options.all && !options.columns)
             throw new Error('No columns specified.');
 
-        let stmt = options.all ? 'SELECT *\n' : 'SELECT ';
+        let stmt = options.all ? 'SELECT *' : 'SELECT ';
         let whereClause = emptyClause;
 
         if (options.columns) 
             stmt += parseColumns(options.columns);
 
-        stmt += `\nFROM ${options.from}`;
+        stmt += `\nFROM ${options.table ?? options.from}`;
 
         if (options.where) 
             whereClause = parseClause('WHERE', options.where);
@@ -74,10 +74,10 @@ module.exports = {
      * @returns {string}
      */
     deleteStr: function(options) {
-        if (!options.table)
+        if (!(options.table || options.from))
             throw new Error('No table specified.');
 
-        let stmt = `DELETE FROM ${options.table}`;
+        let stmt = `DELETE FROM ${options.table ?? options.from}`;
         let whereClause = emptyClause;
 
         if (options.where)