|
| 1 | +<?xml version='1.0' encoding='UTF-8' standalone='no'?> |
| 2 | +<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.14.0" xml:lang="en-US"> |
| 3 | + <compounddef id="_r_e_a_d_m_e_8md" kind="file" language="Markdown"> |
| 4 | + <compoundname>README.md</compoundname> |
| 5 | + <briefdescription> |
| 6 | + </briefdescription> |
| 7 | + <detaileddescription> |
| 8 | + </detaileddescription> |
| 9 | + <programlisting> |
| 10 | +<codeline><highlight class="normal">#<sp/>PLJS</highlight></codeline> |
| 11 | +<codeline></codeline> |
| 12 | +<codeline><highlight class="normal">PLJS<sp/>is<sp/>a<sp/>trusted<sp/>JavaScript<sp/>Language<sp/>Extension<sp/>for<sp/>PostgreSQL.</highlight></codeline> |
| 13 | +<codeline></codeline> |
| 14 | +<codeline><highlight class="normal">It<sp/>is<sp/>compact,<sp/>lightweight,<sp/>and<sp/>fast.</highlight></codeline> |
| 15 | +<codeline></codeline> |
| 16 | +<codeline><highlight class="normal">A<sp/>[Discord](https://discord.gg/XYGSCfVNBC)<sp/>is<sp/>available<sp/>for<sp/>general<sp/>questions,<sp/>discussions,<sp/>and<sp/>support.<sp/>Please<sp/>check<sp/>there<sp/>before<sp/>opening<sp/>an<sp/>issue.</highlight></codeline> |
| 17 | +<codeline></codeline> |
| 18 | +<codeline><highlight class="normal">##<sp/>Technology</highlight></codeline> |
| 19 | +<codeline></codeline> |
| 20 | +<codeline><highlight class="normal">JavaScript:<sp/>[QuickJS](https://bellard.org/quickjs/quickjs.html)</highlight></codeline> |
| 21 | +<codeline></codeline> |
| 22 | +<codeline><highlight class="normal">PostgreSQL:<sp/>14+</highlight></codeline> |
| 23 | +<codeline></codeline> |
| 24 | +<codeline><highlight class="normal">###<sp/>Current<sp/>Status</highlight></codeline> |
| 25 | +<codeline></codeline> |
| 26 | +<codeline><highlight class="normal">1.0.1<sp/>released.</highlight></codeline> |
| 27 | +<codeline></codeline> |
| 28 | +<codeline><highlight class="normal">##<sp/>Using<sp/>PLJS</highlight></codeline> |
| 29 | +<codeline></codeline> |
| 30 | +<codeline><highlight class="normal">Once<sp/>the<sp/>extension<sp/>has<sp/>been<sp/>installed<sp/>(see<sp/>[Building](docs/DEVELOPMENT.md)),<sp/>you<sp/>can<sp/>run:</highlight></codeline> |
| 31 | +<codeline></codeline> |
| 32 | +<codeline><highlight class="normal">```sql</highlight></codeline> |
| 33 | +<codeline><highlight class="normal">CREATE<sp/>EXTENSION<sp/>pljs;</highlight></codeline> |
| 34 | +<codeline><highlight class="normal">```</highlight></codeline> |
| 35 | +<codeline></codeline> |
| 36 | +<codeline><highlight class="normal">from<sp/>your<sp/>SQL<sp/>REPL.</highlight></codeline> |
| 37 | +<codeline></codeline> |
| 38 | +<codeline><highlight class="normal">You<sp/>can<sp/>test<sp/>that<sp/>it<sp/>works<sp/>by<sp/>executing:</highlight></codeline> |
| 39 | +<codeline></codeline> |
| 40 | +<codeline><highlight class="normal">```</highlight></codeline> |
| 41 | +<codeline><highlight class="normal">DO<sp/>$$<sp/>pljs.elog(NOTICE,<sp/>"Hello,<sp/>World!")<sp/>$$<sp/>LANGUAGE<sp/>pljs;</highlight></codeline> |
| 42 | +<codeline><highlight class="normal">```</highlight></codeline> |
| 43 | +<codeline></codeline> |
| 44 | +<codeline><highlight class="normal">##<sp/>Documentation</highlight></codeline> |
| 45 | +<codeline></codeline> |
| 46 | +<codeline><highlight class="normal">-<sp/>[Integrations](docs/INTEGRATION.md)<sp/>-<sp/>How<sp/>PLJS<sp/>integrates<sp/>with<sp/>Postgres</highlight></codeline> |
| 47 | +<codeline><highlight class="normal">-<sp/>[Types](docs/TYPES.md)<sp/>-<sp/>Type<sp/>conversion<sp/>between<sp/>Postgres<sp/>and<sp/>JavaScript</highlight></codeline> |
| 48 | +<codeline><highlight class="normal">-<sp/>[Functions](docs/FUNCTIONS.md)<sp/>-<sp/>Functions<sp/>and<sp/>functionality<sp/>provided<sp/>by<sp/>PLJS</highlight></codeline> |
| 49 | +<codeline><highlight class="normal">-<sp/>[Configuration](docs/CONFIGURATION.md)<sp/>-<sp/>Configuration<sp/>options</highlight></codeline> |
| 50 | +<codeline><highlight class="normal">-<sp/>[Development](docs/DEVELOPMENT.md)<sp/>-<sp/>How<sp/>to<sp/>build<sp/>and<sp/>develop<sp/>PLJS</highlight></codeline> |
| 51 | +<codeline><highlight class="normal">-<sp/>[Versioning](docs/VERSIONING.md)<sp/>-<sp/>PLJS's<sp/>versioning<sp/>policies</highlight></codeline> |
| 52 | +<codeline><highlight class="normal">-<sp/>[Change<sp/>Log](docs/CHANGELOG.md)<sp/>-<sp/>Release<sp/>change<sp/>log</highlight></codeline> |
| 53 | +<codeline><highlight class="normal">-<sp/>[Roadmap](docs/ROADMAP.md)<sp/>-<sp/>PLJS's<sp/>development<sp/>roadmap</highlight></codeline> |
| 54 | +<codeline><highlight class="normal">-<sp/>[Benchmarks](docs/BENCHMARKS.md)<sp/>-<sp/>Benchmarks<sp/>and<sp/>comparisons<sp/>with<sp/>[PLV8](https://github.com/plv8/pljs)</highlight></codeline> |
| 55 | + </programlisting> |
| 56 | + <location file="README.md"/> |
| 57 | + </compounddef> |
| 58 | +</doxygen> |
0 commit comments