# festql

> ORM superfestval

Latest version **1.9.0-0** (published 2024-04-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install festql
pnpm add festql
yarn add festql
bun add festql
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.9.0-0 |
| Published | 2024-04-15 |
| First published | 2023-09-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 561.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | festval |

## Links

- npm: https://www.npmjs.com/package/festql
- npm.io page: https://npm.io/package/festql

## Dependencies (2)

- [dotenv](https://npm.io/package/dotenv.md) ^16.3.1
- [oracledb](https://npm.io/package/oracledb.md) ^6.1.0

## Recent versions

- 1.9.0-0 (latest) — 2024-04-15
- 1.8.0 — 2023-11-13
- 1.7.0 — 2023-11-13
- 1.7.0-0 — 2023-09-29
- 1.6.0-0 — 2023-09-29
- 1.5.0-0 — 2023-09-29
- 1.4.0-0 — 2023-09-29
- 1.3.0-0 — 2023-09-29
- 1.2.0 — 2023-09-29
- 1.1.0 — 2023-09-28

## README

## Festql 
ORM superfestval

### Indice
  * [Iniciando o projeto](#iniciando-o-projeto)
  
  * [Como utilizar](#como-utilizar)
    
    * [Método raw](#método-raw) 

    * [Método raw com bind de valores](#método-raw-com-bind-de-valores)

    * [Método query](#método-query)

### Iniciando o projeto

- Instale a biblioteca

```bash
  npm install festql
  # or yarn festql
```

- Adicione as conexões com o banco de dados às variáveis de
ambiente.

```env
  FESTQL_USER="any_user"
  FESTQL_PASSWORD="any_password"
  FESTQL_CONNECT_STRING="string_connection"
```

### Como Utilizar

- #### Crie uma instancia do FestQl

```ts
  import { FestQl } from 'festql'
  
  export const client = new FestQl();
```

- #### Método raw

```ts
  // importe o client
  const result = client.raw`
    SELECT * FROM table
  `;

  console.log(result);
```

- #### Método raw com bind de valores

```ts
  // importe o client
  const result = client.raw`
    SELECT * FROM table T WHERE T.id = :id

    ${{ id: 1 }}
  `;

  console.log(result);
```

- #### Método query

```ts
  // importe o client
  const result = client.query('SELECT * FROM table');

  console.log(result);
```

### Licenças 
  
  * #### MIT

---
_Source: https://npm.io/package/festql · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._