File: README.md

package info (click to toggle)
pljs 1.0.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,704 kB
  • sloc: ansic: 69,356; javascript: 5,408; sql: 878; makefile: 443; sh: 123
file content (45 lines) | stat: -rw-r--r-- 1,332 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# PLJS

PLJS is a trusted JavaScript Language Extension for PostgreSQL.

It is compact, lightweight, and fast.

A [Discord](https://discord.gg/XYGSCfVNBC) is available for general questions, discussions, and support. Please check there before opening an issue.

## Technology

JavaScript: [QuickJS](https://bellard.org/quickjs/quickjs.html)

PostgreSQL: 14+

### Current Status

1.0.1 released.

## Using PLJS

Once the extension has been installed (see [Building](docs/DEVELOPMENT.md)), you can run:

```sql
CREATE EXTENSION pljs;
```

from your SQL REPL.

You can test that it works by executing:

```
DO $$ pljs.elog(NOTICE, "Hello, World!") $$ LANGUAGE pljs;
```

## Documentation

- [Integrations](docs/INTEGRATION.md) - How PLJS integrates with Postgres
- [Types](docs/TYPES.md) - Type conversion between Postgres and JavaScript
- [Functions](docs/FUNCTIONS.md) - Functions and functionality provided by PLJS
- [Configuration](docs/CONFIGURATION.md) - Configuration options
- [Development](docs/DEVELOPMENT.md) - How to build and develop PLJS
- [Versioning](docs/VERSIONING.md) - PLJS's versioning policies
- [Change Log](docs/CHANGELOG.md) - Release change log
- [Roadmap](docs/ROADMAP.md) - PLJS's development roadmap
- [Benchmarks](docs/BENCHMARKS.md) - Benchmarks and comparisons with [PLV8](https://github.com/plv8/pljs)