pg_orca
pg_orca : ORCA query optimizer as a PostgreSQL extension
Overview
| ID | Extension | Package | Version | Category | License | Language |
|---|---|---|---|---|---|---|
| 2540 | pg_orca
|
pg_orca
|
1.0.0 |
OLAP
|
Apache-2.0
|
C++
|
| Attribute | Has Binary | Has Library | Need Load | Has DDL | Relocatable | Trusted |
|---|---|---|---|---|---|---|
--sLd--
|
No
|
Yes
|
Yes
|
Yes
|
no
|
no
|
| Relationships | |
|---|---|
| See Also | pg_hint_plan
hypopg
index_advisor
|
PG18 only; use session_preload_libraries=pg_orca for automatic planner hook loading.
Packages
| Type | Repo | Version | PG Major Compatibility | Package Pattern | Dependencies |
|---|---|---|---|---|---|
| EXT | PIGSTY
|
1.0.0 |
18
17
16
15
14
|
pg_orca |
- |
| RPM | PIGSTY
|
1.0.0 |
18
17
16
15
14
|
pg_orca_$v |
- |
| DEB | PIGSTY
|
1.0.0 |
18
17
16
15
14
|
postgresql-$v-pg-orca |
- |
| Linux / PG | PG18 | PG17 | PG16 | PG15 | PG14 |
|---|---|---|---|---|---|
el8.x86_64
|
PIGSTY 1.0.0
|
MISS
|
MISS
|
MISS
|
MISS
|
el8.aarch64
|
PIGSTY 1.0.0
|
MISS
|
MISS
|
MISS
|
MISS
|
el9.x86_64
|
PIGSTY 1.0.0
|
MISS
|
MISS
|
MISS
|
MISS
|
el9.aarch64
|
PIGSTY 1.0.0
|
MISS
|
MISS
|
MISS
|
MISS
|
el10.x86_64
|
PIGSTY 1.0.0
|
MISS
|
MISS
|
MISS
|
MISS
|
el10.aarch64
|
PIGSTY 1.0.0
|
MISS
|
MISS
|
MISS
|
MISS
|
d12.x86_64
|
PIGSTY 1.0.0
|
MISS
|
MISS
|
MISS
|
MISS
|
d12.aarch64
|
PIGSTY 1.0.0
|
MISS
|
MISS
|
MISS
|
MISS
|
d13.x86_64
|
PIGSTY 1.0.0
|
MISS
|
MISS
|
MISS
|
MISS
|
d13.aarch64
|
PIGSTY 1.0.0
|
MISS
|
MISS
|
MISS
|
MISS
|
u22.x86_64
|
PIGSTY 1.0.0
|
MISS
|
MISS
|
MISS
|
MISS
|
u22.aarch64
|
PIGSTY 1.0.0
|
MISS
|
MISS
|
MISS
|
MISS
|
u24.x86_64
|
PIGSTY 1.0.0
|
MISS
|
MISS
|
MISS
|
MISS
|
u24.aarch64
|
PIGSTY 1.0.0
|
MISS
|
MISS
|
MISS
|
MISS
|
u26.x86_64
|
PIGSTY 1.0.0
|
MISS
|
MISS
|
MISS
|
MISS
|
u26.aarch64
|
PIGSTY 1.0.0
|
MISS
|
MISS
|
MISS
|
MISS
|
Source
pig build pkg pg_orca; # build rpm/debInstall
Make sure PGDG and PIGSTY repo available:
pig repo add pgsql -u # add both repo and update cacheInstall this extension with pig:
pig install pg_orca; # install via package name, for the active PG version
pig install pg_orca -v 18; # install for PG 18Config this extension to shared_preload_libraries:
shared_preload_libraries = 'pg_orca';Create this extension with:
CREATE EXTENSION pg_orca;Usage
Sources: pgorca README, entrypoint/GUC source, control file.
pg_orca plugs the ORCA cost-based optimizer from the Greenplum/Apache Cloudberry lineage into a standard PostgreSQL 18 server. The upstream README describes this project as PostgreSQL 18-only, and the local package metadata also marks it for PG18 only.
Enable ORCA For A Session
CREATE EXTENSION loads the library in the current session, so the pg_orca.* GUCs and planner hook are available immediately:
CREATE EXTENSION pg_orca;
SET pg_orca.enable_orca = on;
EXPLAIN
SELECT *
FROM orders
WHERE customer_id = 42
AND created_at >= now() - interval '30 days';If ORCA cannot handle a query, the README says it falls back to the standard PostgreSQL planner automatically. Turn on fallback logging while validating a workload:
SET pg_orca.trace_fallback = on;Preload For New Connections
For automatic planner-hook loading in later sessions, upstream recommends session_preload_libraries, not shared_preload_libraries:
ALTER DATABASE mydb SET session_preload_libraries = 'pg_orca';
ALTER DATABASE mydb SET pg_orca.enable_orca = on;Existing sessions are unaffected until they reconnect. If another session preload library is already configured, include both values explicitly:
ALTER DATABASE mydb
SET session_preload_libraries = 'pg_orca,pg_stat_statements';Role-local and cluster-wide scopes are also valid:
ALTER ROLE bench SET session_preload_libraries = 'pg_orca';
ALTER SYSTEM SET session_preload_libraries = 'pg_orca';
SELECT pg_reload_conf();Tuning And Diagnostics
The README documents these main GUCs:
pg_orca.enable_orca: enable ORCA; defaultoff.pg_orca.trace_fallback: log fallback to the standard planner; defaultoff.optimizer_segments: segment count for costing; default1.optimizer_sort_factor: sort cost scaling; default1.0.optimizer_metadata_caching: cache relation metadata; defaulton.optimizer_mdcache_size: metadata cache size in KB; default16384.optimizer_search_strategy_path: optional custom search strategy XML path.
The entrypoint source also defines additional ORCA tuning and debug GUCs such as optimizer_join_order, pg_orca.join_order_dynamic_threshold, pg_orca.cost_model, and optimizer_print_*. Treat those as workload/debug knobs and validate plans before keeping them in a persistent database setting.
Caveats
- PostgreSQL 18 only.
- Use
session_preload_libraries = 'pg_orca'for automatic loading in new sessions. - ORCA is disabled by default after loading; set
pg_orca.enable_orca = on. - Fallback to the PostgreSQL planner is expected for unsupported queries; enable
pg_orca.trace_fallbackwhen checking coverage.