https://github.com/gajus/slonik-sql-tag-raw

Slonik SQL tag for constructing dynamic queries.
https://github.com/gajus/slonik-sql-tag-raw

slonik sql tag

Last synced: 14 days ago
JSON representation

Slonik SQL tag for constructing dynamic queries.

• Host: GitHub
• URL: https://github.com/gajus/slonik-sql-tag-raw
• Owner: gajus
• License: other
• Created: 2019-11-04T22:02:48.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-07T18:30:16.000Z (6 months ago)
• Last Synced: 2024-10-19T00:18:33.673Z (28 days ago)
• Topics: slonik, sql, tag
• Language: TypeScript
• Size: 1.68 MB
• Stars: 15
• Watchers: 4
• Forks: 6
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# slonik-sql-tag-raw

[![Travis build status](http://img.shields.io/travis/gajus/slonik-sql-tag-raw/master.svg?style=flat-square)](https://app.travis-ci.com/github/gajus/slonik-sql-tag-raw)

[![Coveralls](https://img.shields.io/coveralls/gajus/slonik-sql-tag-raw.svg?style=flat-square)](https://coveralls.io/github/gajus/slonik-sql-tag-raw)

[![NPM version](http://img.shields.io/npm/v/slonik-sql-tag-raw.svg?style=flat-square)](https://www.npmjs.org/package/slonik-sql-tag-raw)

[![Canonical Code Style](https://img.shields.io/badge/code%20style-canonical-blue.svg?style=flat-square)](https://github.com/gajus/canonical)

[![Twitter Follow](https://img.shields.io/twitter/follow/kuizinas.svg?style=social&label=Follow)](https://twitter.com/kuizinas)

[Slonik](https://github.com/gajus/slonik) SQL tag for constructing dynamic queries.

> [!WARNING]

> Deprecated in favor of https://github.com/gajus/slonik monorepo.

## Warning

There are no known use cases for generating queries using `raw` that aren't covered by nesting bound `sql` expressions or by one of the other existing [query building methods](#slonik-query-building). `raw` exists only as a mechanism to execute externally stored _static_ queries (e.g. queries stored in files).

## Usage

```js

import {

  raw,

} from 'slonik-sql-tag-raw';

```

### `raw`

```js

(

  sql: string,

  values?: $ReadOnlyArray

) => RawSqlTokenType;

```

Raw/ dynamic SQL can be inlined using `raw`, e.g.

```js

sql`

  SELECT 1

  FROM ${raw('"bar"')}

`;

```

Produces:

```js

{

  sql: 'SELECT 1 FROM "bar"',

  values: []

}

```

The second parameter of the `raw` can be used to bind [positional parameter](https://www.postgresql.org/docs/current/sql-expressions.html#SQL-EXPRESSIONS-PARAMETERS-POSITIONAL) values, e.g.

```js

sql`

  SELECT ${raw('$1', [1])}

`;

```

Produces:

```js

{

  sql: 'SELECT $1',

  values: [

    1

  ]

}

```

#### Named parameters

`raw` supports named parameters, e.g.

```js

sql`

  SELECT ${raw(':foo, :bar', {bar: 'BAR', foo: 'FOO'})}

`;

```

Produces:

```js

{

  sql: 'SELECT $1, $2',

  values: [

    'FOO',

    'BAR'

  ]

}

```

Named parameters are matched using `/[\s,(]:([a-z_]+)/g` regex.