# @ladc/sql-bricks-modifier

> Use the query builder 'SQL Bricks' with the LADC API.

Latest version **0.22.7** (published 2020-06-09) · CC0-1.0 license · 0 weekly downloads

## Install

```sh
npm install @ladc/sql-bricks-modifier
pnpm add @ladc/sql-bricks-modifier
yarn add @ladc/sql-bricks-modifier
bun add @ladc/sql-bricks-modifier
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.22.7 |
| Published | 2020-06-09 |
| First published | 2018-10-04 |
| Weekly downloads | 0 |
| License | CC0-1.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 0 |
| Unpacked size | 18 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | Paleo |
| Maintainers | paleo |
| Keywords | sql, query, builder, ladc |

## Links

- npm: https://www.npmjs.com/package/@ladc/sql-bricks-modifier
- Repository: https://github.com/paroi-tech/ladc
- Homepage: https://github.com/paroi-tech/ladc/tree/master/sql-bricks-modifier
- Issues: https://github.com/paroi-tech/ladc/issues
- npm.io page: https://npm.io/package/@ladc/sql-bricks-modifier

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads

## Recent versions

- 0.22.7 (latest) — 2020-06-09
- 0.22.6 — 2020-06-08
- 0.22.5 — 2020-01-11
- 0.22.4 — 2019-11-03
- 0.22.3 — 2019-11-03
- 0.22.2 — 2019-10-27
- 0.22.0 — 2019-10-27
- 0.21.0 — 2019-10-26
- 0.20.2 — 2018-12-11
- 0.20.1 — 2018-12-07
- 0.20.0 — 2018-12-07
- 0.19.1 — 2018-10-04
- 0.19.0 — 2018-10-04

## README

# @ladc/sql-bricks-modifier

<!-- [![Dependencies Status](https://david-dm.org/paroi-tech/ladc-sql-bricks-modifier/status.svg)](https://david-dm.org/paroi-tech/ladc-sql-bricks-modifier)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/395c5ccd121545f4860c1bd05740de7e)](https://www.codacy.com/manual/paroi-tech/ladc-sql-bricks-modifier?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=paroi-tech/ladc-sql-bricks-modifier&amp;utm_campaign=Badge_Grade) -->

[![Build Status](https://travis-ci.com/paroi-tech/ladc.svg?branch=master)](https://travis-ci.com/paroi-tech/ladc)
[![npm](https://img.shields.io/npm/dm/@ladc/sql-bricks-modifier)](https://www.npmjs.com/package/@ladc/sql-bricks-modifier)
![Type definitions](https://img.shields.io/npm/types/@ladc/sql-bricks-modifier)
[![GitHub](https://img.shields.io/github/license/paroi-tech/ladc)](https://github.com/paroi-tech/ladc)

[LADC](https://github.com/paroi-tech/ladc/tree/master/ladc) is a common API on top of relational database (SQL) connectors. It can connect to Postgresql, MariaDB / MySQL, SQLite. The API is inspired from PDO and JDBC. It’s named LADC for “a Layer Above Database Connectors”.

This package is a plugin for LADC. It integrates the query builder [SQL Bricks](https://github.com/CSNW/sql-bricks) to LADC.

## Additional API

This package overloads the following methods of the LADC objects `MainConnection` and `TransactionConnection`:

- `prepare(sqlBricksQuery)`
- `exec(sqlBricksQuery)`
- `all(sqlBricksSelectStatement)`
- `singleRow(sqlBricksSelectStatement)`
- `singleValue(sqlBricksSelectStatement)`
- `cursor(sqlBricksSelectStatement)`

## How to use SQL Bricks with LADC (example with SQLite)

Install with LADC and a connector (here is an example with SQLite):

```
npm install ladc @ladc/sqlite3-adapter sql-bricks @ladc/sql-bricks-modifier
```

Here is how to create a connection:

```js
import ladc from "ladc";
import sqlite3Adapter from "@ladc/sqlite3-adapter";
import sqlBricksModifier from "@ladc/sql-bricks-modifier";

const cn = ladc({
  adapter: sqlite3Adapter({ fileName: `${__dirname}/mydb.sqlite` }),
  modifier: sqlBricksModifier(),
});
```

Then, use it:

```js
import { select } from "sql-bricks";

async function test(cn) {
  const q = select("col1, col2").from("table1");
  const rows = await cn.all(q);
  console.log(rows);
}
```

## How to use SQL Bricks with LADC: The case of MySQL

MySQL requires a specific `placeholder` option for SQL Bricks:

```js
import ladc from "ladc";
import mysql2Adapter from "@ladc/mysql2-adapter";
import sqlBricksModifier from "@ladc/sql-bricks-modifier";

const cn = ladc({
  adapter: mysql2Adapter({
    mysql2Config: {
      host: "-my-server-",
      database: "-my-database-",
      user: "-my-user-",
      password: "-my-password-",
    },
  }),
  modifier: sqlBricksModifier({
    toParamsOptions: { placeholder: "?" }, // ← Specific to MySQL
  }),
});
```

Now, the API can be used as usual.

## Contribute

With VS Code, our recommanded plugin is:

- **TSLint** from Microsoft (`ms-vscode.vscode-typescript-tslint-plugin`)

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