Skip to content

ext/pgsql: add meta_cache per-link metadata caching #21885

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
arshidkv12 wants to merge 5 commits into
base: master
Choose a base branch
from
+177 −2
Draft

ext/pgsql: add meta_cache per-link metadata caching #21885

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3bbec1b
ext/pgsql: add meta_cache per-link metadata caching
arshidkv12 Apr 27, 2026
884dcbd
ext/pgsql: add meta_cache per-link metadata caching
arshidkv12 Apr 28, 2026
5c0e4a9
ext/pgsql: add meta_cache per-link metadata caching
arshidkv12 Apr 28, 2026
638e354
ext/pgsql: add meta_cache per-link metadata caching
arshidkv12 Apr 28, 2026
0bb7d6d
ext/pgsql: add meta_cache per-link metadata caching
arshidkv12 Apr 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 98 additions & 2 deletions ext/pgsql/pgsql.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,15 @@ static zend_function *pgsql_link_get_constructor(zend_object *object) {
return NULL;
}

static inline void pgsql_meta_cache_destroy(HashTable **cache)
{
if (*cache) {
zend_hash_destroy(*cache);
FREE_HASHTABLE(*cache);
*cache = NULL;
}
}

static void pgsql_link_free(pgsql_link_handle *link)
{
PGresult *res;
Expand All @@ -194,6 +203,9 @@ static void pgsql_link_free(pgsql_link_handle *link)
FREE_HASHTABLE(link->notices);
link->notices = NULL;
}

pgsql_meta_cache_destroy(&link->meta_cache);

}

static void pgsql_link_free_obj(zend_object *obj)
Expand Down Expand Up @@ -637,6 +649,15 @@ PHP_RSHUTDOWN_FUNCTION(pgsql)
PGG(default_link) = NULL;
}

zval *pgsql_link;

ZEND_HASH_FOREACH_VAL(&PGG(connections), pgsql_link) {
pgsql_link_handle *link = Z_PGSQL_LINK_P(pgsql_link);
if (link) {
pgsql_meta_cache_destroy(&link->meta_cache);
}
} ZEND_HASH_FOREACH_END();

zend_hash_destroy(&PGG(field_oids));
zend_hash_destroy(&PGG(table_oids));
/* clean up persistent connection */
Expand Down Expand Up @@ -765,7 +786,11 @@ static void php_pgsql_do_connect(INTERNAL_FUNCTION_PARAMETERS, int persistent)
link->conn = pgsql;
link->hash = zend_string_copy(str.s);
link->notices = NULL;
link->meta_cache = NULL;
link->persistent = 1;

zend_hash_update(&PGG(connections), str.s, return_value);

} else { /* Non persistent connection */
zval *index_ptr;

Expand Down Expand Up @@ -816,6 +841,7 @@ static void php_pgsql_do_connect(INTERNAL_FUNCTION_PARAMETERS, int persistent)
link->conn = pgsql;
link->hash = zend_string_copy(str.s);
link->notices = NULL;
link->meta_cache = NULL;
link->persistent = 0;

/* add it to the hash */
Expand Down Expand Up @@ -1182,6 +1208,9 @@ PHP_FUNCTION(pg_query)
php_error_docref(NULL, E_NOTICE,"Cannot set connection to blocking mode");
RETURN_FALSE;
}

pgsql_meta_cache_destroy(&link->meta_cache);

while ((pgsql_result = PQgetResult(pgsql))) {
PQclear(pgsql_result);
leftover = true;
Expand Down Expand Up @@ -1310,6 +1339,9 @@ PHP_FUNCTION(pg_query_params)
php_error_docref(NULL, E_NOTICE,"Cannot set connection to blocking mode");
RETURN_FALSE;
}

pgsql_meta_cache_destroy(&link->meta_cache);

while ((pgsql_result = PQgetResult(pgsql))) {
PQclear(pgsql_result);
leftover = true;
Expand Down Expand Up @@ -1405,6 +1437,9 @@ PHP_FUNCTION(pg_prepare)
php_error_docref(NULL, E_NOTICE,"Cannot set connection to blocking mode");
RETURN_FALSE;
}

pgsql_meta_cache_destroy(&link->meta_cache);

while ((pgsql_result = PQgetResult(pgsql))) {
PQclear(pgsql_result);
leftover = true;
Expand Down Expand Up @@ -1493,6 +1528,9 @@ PHP_FUNCTION(pg_execute)
php_error_docref(NULL, E_NOTICE,"Cannot set connection to blocking mode");
RETURN_FALSE;
}

pgsql_meta_cache_destroy(&link->meta_cache);

while ((pgsql_result = PQgetResult(pgsql))) {
PQclear(pgsql_result);
leftover = true;
Expand Down Expand Up @@ -1699,6 +1737,25 @@ static zend_string *get_field_name(PGconn *pgsql, Oid oid)
return ret;
}

static pgsql_link_handle *pgsql_get_link_from_conn(PGconn *conn)
{
zval *pgsql_link;

if (!conn) {
return NULL;
}

ZEND_HASH_FOREACH_VAL(&PGG(connections), pgsql_link) {
pgsql_link_handle *link = Z_PGSQL_LINK_P(pgsql_link);

if (link && link->conn == conn) {
return link;
}
} ZEND_HASH_FOREACH_END();

return NULL;
}

/* Returns the name of the table field belongs to, or table's oid if oid_only is true */
PHP_FUNCTION(pg_field_table)
{
Expand Down Expand Up @@ -3979,6 +4036,8 @@ PHP_FUNCTION(pg_send_query)
RETURN_FALSE;
}

pgsql_meta_cache_destroy(&link->meta_cache);

if (_php_pgsql_link_has_results(pgsql)) {
php_error_docref(NULL, E_NOTICE,
"There are results on this connection. Call pg_get_result() until it returns FALSE");
Expand Down Expand Up @@ -4052,6 +4111,8 @@ PHP_FUNCTION(pg_send_query_params)
php_error_docref(NULL, E_NOTICE, "Cannot set connection to nonblocking mode");
RETURN_FALSE;
}

pgsql_meta_cache_destroy(&link->meta_cache);

if (_php_pgsql_link_has_results(pgsql)) {
php_error_docref(NULL, E_NOTICE,
Expand Down Expand Up @@ -4133,6 +4194,8 @@ PHP_FUNCTION(pg_send_prepare)
RETURN_FALSE;
}

pgsql_meta_cache_destroy(&link->meta_cache);

if (_php_pgsql_link_has_results(pgsql)) {
php_error_docref(NULL, E_NOTICE,
"There are results on this connection. Call pg_get_result() until it returns FALSE");
Expand Down Expand Up @@ -4208,6 +4271,8 @@ PHP_FUNCTION(pg_send_execute)
RETURN_FALSE;
}

pgsql_meta_cache_destroy(&link->meta_cache);

if (_php_pgsql_link_has_results(pgsql)) {
php_error_docref(NULL, E_NOTICE,
"There are results on this connection. Call pg_get_result() until it returns FALSE");
Expand Down Expand Up @@ -4539,7 +4604,6 @@ PHP_FUNCTION(pg_flush)

/* {{{ php_pgsql_meta_data
* table_name must not be empty
* TODO: Add meta_data cache for better performance
*/
PHP_PGSQL_API zend_result php_pgsql_meta_data(PGconn *pg_link, const zend_string *table_name, zval *meta, bool extended)
{
Expand All @@ -4550,6 +4614,7 @@ PHP_PGSQL_API zend_result php_pgsql_meta_data(PGconn *pg_link, const zend_string
size_t new_len, len;
int i, num_rows, err;
zval elem;
pgsql_link_handle *link;

ZEND_ASSERT(ZSTR_LEN(table_name) != 0);

Expand Down Expand Up @@ -4620,14 +4685,28 @@ PHP_PGSQL_API zend_result php_pgsql_meta_data(PGconn *pg_link, const zend_string
smart_str_0(&querystr);
efree(src);

link = pgsql_get_link_from_conn(pg_link);

if (link && link->meta_cache) {
zval *meta_cache = zend_hash_find(link->meta_cache, querystr.s);

if (meta_cache) {
if (Z_TYPE_P(meta) != IS_UNDEF) {
zval_ptr_dtor(meta);
}
ZVAL_COPY(meta, meta_cache);
smart_str_free(&querystr);
return SUCCESS;
}
}

pg_result = PQexec(pg_link, ZSTR_VAL(querystr.s));
if (PQresultStatus(pg_result) != PGRES_TUPLES_OK || (num_rows = PQntuples(pg_result)) == 0) {
php_error_docref(NULL, E_WARNING, "Table '%s' doesn't exists", ZSTR_VAL(table_name));
smart_str_free(&querystr);
PQclear(pg_result);
return FAILURE;
}
smart_str_free(&querystr);

for (i = 0; i < num_rows; i++) {
char *name;
Expand Down Expand Up @@ -4658,6 +4737,21 @@ PHP_PGSQL_API zend_result php_pgsql_meta_data(PGconn *pg_link, const zend_string
name = PQgetvalue(pg_result,i,0);
add_assoc_zval(meta, name, &elem);
}

if(link) {
if (!link->meta_cache) {
ALLOC_HASHTABLE(link->meta_cache);
zend_hash_init(link->meta_cache, 8, NULL, ZVAL_PTR_DTOR, 0);
}

zval meta_copy;
ZVAL_COPY(&meta_copy, meta);
zend_string *key = zend_string_copy(querystr.s);

zend_hash_update( link->meta_cache, key, &meta_copy);
zend_string_release(key);
}
smart_str_free(&querystr);
PQclear(pg_result);

return SUCCESS;
Expand Down Expand Up @@ -6083,6 +6177,8 @@ PHP_FUNCTION(pg_delete)
CHECK_PGSQL_LINK(link);
pg_link = link->conn;

pgsql_meta_cache_destroy(&link->meta_cache);

if (php_pgsql_flush_query(pg_link)) {
php_error_docref(NULL, E_NOTICE, "Detected unhandled result(s) in connection");
}
Expand Down
1 change: 1 addition & 0 deletions ext/pgsql/php_pgsql.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ typedef struct pgsql_link_handle {
PGconn *conn;
zend_string *hash;
HashTable *notices;
HashTable *meta_cache;
bool persistent;
zend_object std;
} pgsql_link_handle;
Expand Down
78 changes: 78 additions & 0 deletions ext/pgsql/tests/pg_meta_data_cache.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
--TEST--
pg_meta_data() - cache behavior and invalidation
--EXTENSIONS--
pgsql
--SKIPIF--
<?php include("inc/skipif.inc"); ?>
--FILE--
<?php
include('inc/config.inc');

$conn = pg_connect($conn_str);
if (!$conn) die("Connection failed\n");

pg_query($conn, "DROP TABLE IF EXISTS test_meta_cache");
pg_query($conn, "CREATE TABLE test_meta_cache (id SERIAL PRIMARY KEY, name TEXT)");
$meta1 = pg_meta_data($conn, 'test_meta_cache');
if (!isset($meta1['id']) || !isset($meta1['name'])) {
echo "FAIL: Basic metadata missing columns\n";
var_dump(array_keys($meta1));
} else {
echo "Basic metadata: OK (columns: " . implode(', ', array_keys($meta1)) . ")\n";
}

pg_query($conn, "ALTER TABLE test_meta_cache ADD COLUMN age INT");
$meta2 = pg_meta_data($conn, 'test_meta_cache');
if (!isset($meta2['age'])) {
echo "FAIL: Column 'age' not seen after ALTER\n";
var_dump(array_keys($meta2));
} else {
echo "ALTER invalidation: OK ('age' found)\n";
}

pg_query($conn, "DROP TABLE test_meta_cache");
pg_query($conn, "CREATE TABLE test_meta_cache (only_column TEXT)");
$meta3 = pg_meta_data($conn, 'test_meta_cache');
if (isset($meta3['id']) || isset($meta3['name']) || isset($meta3['age'])) {
echo "FAIL: Old columns still present after DROP/CREATE\n";
var_dump(array_keys($meta3));
} elseif (!isset($meta3['only_column'])) {
echo "FAIL: New column 'only_column' missing\n";
var_dump(array_keys($meta3));
} else {
echo "DROP/CREATE invalidation: OK (only 'only_column' present)\n";
}

$meta_ext = pg_meta_data($conn, 'test_meta_cache', true);
if (!isset($meta_ext['only_column']['is enum']) || !isset($meta_ext['only_column']['description'])) {
echo "FAIL: Extended metadata missing extra fields\n";
var_dump($meta_ext['only_column']);
} else {
echo "Extended metadata: OK (has 'is enum', 'description')\n";
}

$meta_schema = pg_meta_data($conn, 'public.test_meta_cache');
if (!isset($meta_schema['only_column'])) {
echo "FAIL: Schema-qualified name not recognized\n";
} else {
echo "Schema-qualified name: OK";
}
$meta_false = pg_meta_data($conn, 'non_existent_table');
pg_query($conn, "DROP TABLE test_meta_cache");
pg_close($conn);
echo "Done\n";
?>
--CLEAN--
<?php
include('inc/config.inc');
$db = pg_connect($conn_str);
pg_query($db, "DROP TABLE IF EXISTS test_meta_cache CASCADE");
?>
--EXPECTF--
Basic metadata: OK (columns: %s)
ALTER invalidation: OK ('age' found)
DROP/CREATE invalidation: OK (only 'only_column' present)
Extended metadata: OK (has 'is enum', 'description')
Schema-qualified name: OK
Warning: pg_meta_data(): Table 'non_existent_table' doesn't exists in %s on line %d
Done
Loading