Databases
Omnigres makes Postgres a developer-first application platform. You can deploy a single database instance and it can host your entire application, scaling as needed.
The fastest way to try Omnigres out is by using its container image:
docker volume create omnigres
docker run --name omnigres --mount source=omnigres,target=/var/lib/postgresql/data \
-p 127.0.0.1:5432:5432 -p 127.0.0.1:8080:8080 --rm ghcr.io/omnigres/omnigres:latest
# Now you can connect to it:
psql -h localhost -p 5432 -U omnigres omnigres # password is `omnigres`
Postgres parameters such as database, user or password can be overridden as per the "Environment Variables" section in postgres image instructions
You can access the HTTP server at localhost:8080
If you can't use the pre-built image (for example, you are running a fork or made changes), you can build the image yourself:
# Build the image
DOCKER_BUILDKIT=1 docker build . -t ghcr.io/omnigres/omnigres
Omnigres extensions can also be downloaded and installed in any postgres installation with file system access.
Here we expect you are running the container image, which has omni_httpd and omni_web extensions provisioned by default.
Let's start with a traditional example. Here we will instruct the handler that is provisioned by omni_httpd by default to use the enclosed query to greet the world.
Below, we'll show examples in Python and plain SQL (or PL/pgSQL). Support for more languages is coming!
$ curl localhost:8080
Hello, world!
from omni_python import pg
from flask import Flask
from omni_http.omni_httpd import flask
app = Flask('myapp')
@app.route('/')
def hello():
return "Hello, world!"
handle = pg(flask.Adapter(app))
To connect the endpoint:
update omni_httpd.handlers
set
query =
$$select handle(request.*) from request$$;
NB: Please note that you will need to follow Python setup steps for the time being before our CLI tooling is ready.
You can also achieve the same using plain SQL with very little setup.
update omni_httpd.handlers
set
query =
$$select omni_httpd.http_response('Hello, world!') from request$$;
Now, let's make it more personal and let it greet the requester by name.
$ curl "localhost:8080?name=John"
Hello, John!
from flask import request # we need to access `request`
@app.route('/')
def hello():
return f"Hello, {request.args.get('name', 'world')}!"
update omni_httpd.handlers
set
query =
$$select omni_httpd.http_response('Hello, ' ||
coalesce(omni_web.param_get(request.query_string, 'name'), 'world') || '!')
from request$$;
This, of course, only barely scratches the surface, but it may give you a very high-level concept of how Omnigres web services can be built.
For a more complex example, that uses the underlying database and employs more real-world layout, check out this MOTD service example.
Below is the current list of components being worked on, experimented with and discussed. This list will change (and grow) over time.
Name | Status | Description |
---|---|---|
omni and Omni interface | :white_check_mark: First release candidate | Advanced adapter for Postgres extensions |
omni_schema | :white_check_mark: First release candidate | Application schema management |
omni_id | :white_check_mark: First release candidate | Identity types |
omni_aws | :white_check_mark: First release candidate | AWS APIs |
omni_json | :white_check_mark: First release candidate | JSON toolkit |
omni_xml | :white_check_mark: First release candidate | XML toolkit |
omni_http | :white_check_mark: First release candidate | Common HTTP types library |
omni_httpd, omni_web | :white_check_mark: First release candidate | Serving HTTP in Postgres and building services in SQL |
omni_session | :white_check_mark: First release candidate | Session management |
omni_mimetypes | :white_check_mark: First release candidate | MIME types and file extensions |
omni_httpc | :white_check_mark: First release candidate | HTTP client |
omni_sql | :construction: Extremely limited API surface | Programmatic SQL manipulation |
omni_vfs | :ballot_box_with_check: Initial prototype | Virtual File System interface |
omni_containers | :ballot_box_with_check: Initial prototype | Managing containers |
omni_manifest | :ballot_box_with_check: Initial prototype | Improved extension installation |
omni_types | :white_check_mark: First release candidate | Advanced Postgres typing techniques (sum types, etc.) |
omni_seq | :white_check_mark: First release candidate | Extended Postgres sequence tooling |
omni_var | :white_check_mark: First release candidate | Variable management |
omni_txn | :white_check_mark: First release candidate | Transaction management |
omni_python | :ballot_box_with_check: Initial prototype | First-class Python Development Experience |
omni_os | :ballot_box_with_check: Initial prototype | Access to the operating system |
omni_polyfill | :white_check_mark: First release | Provides polyfills for older versions of Postgres |
omni_git | :lab_coat: Early experiments (unpublished) | Postgres Git client |
omni_reactive | :spiral_calendar: Haven't started yet | Reactive queries |
To build and run Omnigres, you would need:
cmake -S . -B build
cmake --build build --parallel
make -j psql_<COMPONENT_NAME> # for example, `psql_omni_containers`
To use a specific Python build use the cmake flag Python3_EXECUTABLE
:
cmake -S . -B build -DPython3_EXECUTABLE=/path/to/python
Remove build
and .pg
directories for a clean rebuild:
rm -rf .pg build
# in the build directory
CTEST_PARALLEL_LEVEL=$(nproc) make -j $(nproc) all test