Advanced multi-threaded PostgreSQL connection pooler and request router.
Odyssey is production-ready, it is being used in large production setups. We appreciate any kind of feedback and contribution to the project.
Design goals and main features
Odyssey can significantly scale processing performance by
specifying a number of additional worker threads. Each worker thread is
responsible for authentication and proxying client-to-server and server-to-client
requests. All worker threads are sharing global server connection pools.
Multi-threaded design plays important role in
Advanced transactional pooling
Odyssey tracks current transaction state and in case of unexpected client
disconnection can emit automatic
Cancel connection and do
abandoned transaction, before putting server connection back to
the server pool for reuse. Additionally, last server connection owner client
is remembered to reduce a need for setting up client options on each
Better pooling control
Odyssey allows to define connection pools as a pair of
Each defined pool can have separate authentication, pooling mode and limits settings.
Odyssey has full-featured
SSL/TLS support and common authentication methods
clear text both for client and server authentication.
Odyssey supports PAM & LDAP authentication, this methods operates similarly to
clear text auth except that it uses
PAM/LDAP to validate user name/password pairs. PAM optionally checks the connected remote host name or IP address.
Additionally it allows to block each pool user separately.
Odyssey generates universally unique identifiers
uuid for client and server connections.
Any log events and client error responses include the id, which then can be used to
uniquely identify client and track actions. Odyssey can save log events into log file and
using system logger.
Odyssey supports multiple command line options. Use
/path/to/odyssey --help to see more
Architecture and internals
Odyssey has sophisticated asynchronous multi-threaded architecture which is driven by custom made coroutine engine: machinarium. Main idea behind coroutine design is to make event-driven asynchronous applications to look and feel like being written in synchronous-procedural manner instead of using traditional callback approach.
One of the main goal was to make code base understandable for new developers and to make an architecture easily extensible for future development.
More information: Architecture and internals.
Currently Odyssey runs only on Linux. Supported platforms are x86/x86_64.
To build you will need:
- cmake >= 3.12.4
- gcc >= 4.6
- pg_config utility is in the PATH
git clone git://github.com/yandex/odyssey.git cd odyssey make local_build
Adapt odyssey-dev.conf then:
Use docker environment for development (helpful for Mac users)
Set up your CLion to build project in container, manual.
Database and user
- example console