Skip to main content

# Introduction

Not finished

This documentation is far from being finished.
It holds the most useful information, but lacks depth and examples.
It will be expanded in the near future.

awSQL is a fast and reliable database query tool.

It is designed to minimize the risk of sql-injections while maximizing usability and safety.

It prevents you from altering a whole set of rows by accident.

awSQL is designed to programmatically work with databases in an obvious manner. No more writing pesky and confusing sql-queries

## Getting Started​

To get started all you need is:

- An hosted database
  - Your credentials
- The `mysql` module from npm.

To install the `mysql` module, type:

    npm install mysql

→ Next move the /awSQL folder into your workspace.

Now you can access the default exports:

    const {awSQL, Structure} = require("./awSQL");

    const instance = awSQL.createInstance("localhost", "myUser", "myPass");
    instance.connect();

    // Do stuff

## Exports​

awSQL exports 2 modules to use:

- awSQL as an instance
- Structure