8000 Clean up some prefixes for function parameters by AndersAstrand · Pull Request #418 · percona/postgres · GitHub
[go: up one dir, main page]
Skip to content

Clean up some prefixes for function parameters #418

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

Merged
merged 2 commits into from
Jun 12, 2025
Merged

Clean up some prefixes for function parameters #418

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab09583
Remove provider_ prefix from parameter names
AndersAstrand Jun 11, 2025
324ac4c
Remove double prefix from provider name and id
AndersAstrand Jun 11, 2025
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
Next Next commit
Remove provider_ prefix from parameter names 
There was no reason for name and type to be prefixed in the add/change
key provider functions while options was not.

The output from the list_providers functions had them for name and type,
but not id nor options. So remove the prefixes there aswell.

In other functions the prefixes serve to show what parameters is about
the provider and which are about something else.
  • Loading branch information
@AndersAstrand
AndersAstrand committed Jun 11, 2025
commit ab09583a9dda330e0430deadd19afefd696d20bd
4 changes: 2 additions & 2 deletions contrib/pg_tde/expected/default_principal_key.out
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ SELECT key_provider_id, key_provider_name, key_name
-- fails
SELECT pg_tde_delete_global_key_provider('file-provider');
ERROR: Can't delete a provider which is currently in use
SELECT id, provider_name FROM pg_tde_list_all_global_key_providers();
id | provider_name
SELECT id, name FROM pg_tde_list_all_global_key_providers();
id | name
----+---------------
-2 | file-provider
(1 row)
Expand Down
50 changes: 25 additions & 25 deletions contrib/pg_tde/expected/key_provider.out
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ SELECT pg_tde_add_database_key_provider_file('file-provider2','/tmp/pg_tde_test_
SELECT pg_tde_add_database_key_provider_file('file-provider','/tmp/pg_tde_test_keyring_dup.per');
ERROR: Key provider "file-provider" already exists.
SELECT * FROM pg_tde_list_all_database_key_providers();
id | provider_name | provider_type | options
----+----------------+---------------+--------------------------------------------
1 | file-provider | file | {"path" : "/tmp/pg_tde_test_keyring.per"}
2 | file-provider2 | file | {"path" : "/tmp/pg_tde_test_keyring2.per"}
id | name | type | options
----+----------------+------+--------------------------------------------
1 | file-provider | file | {"path" : "/tmp/pg_tde_test_keyring.per"}
2 | file-provider2 | file | {"path" : "/tmp/pg_tde_test_keyring2.per"}
(2 rows)

SELECT pg_tde_verify_key();
Expand All @@ -45,19 +45,19 @@ SELECT pg_tde_verify_key();
SELECT pg_tde_change_database_key_provider_file('not-existent-provider','/tmp/pg_tde_test_keyring.per');
ERROR: key provider "not-existent-provider" does not exists
SELECT * FROM pg_tde_list_all_database_key_providers();
id | provider_name | provider_type | options
----+----------------+---------------+--------------------------------------------
1 | file-provider | file | {"path" : "/tmp/pg_tde_test_keyring.per"}
2 | file-provider2 | file | {"path" : "/tmp/pg_tde_test_keyring2.per"}
id | name | type | options
----+----------------+------+--------------------------------------------
1 | file-provider | file | {"path" : "/tmp/pg_tde_test_keyring.per"}
2 | file-provider2 | file | {"path" : "/tmp/pg_tde_test_keyring2.per"}
(2 rows)

SELECT pg_tde_change_database_key_provider('file', 'file-provider', '{"path": {"foo": "/tmp/pg_tde_test_keyring.per"}}');
ERROR: key provider value cannot be an object
SELECT * FROM pg_tde_list_all_database_key_providers();
id | provider_name | provider_type | options
----+----------------+---------------+--------------------------------------------
1 | file-provider | file | {"path" : "/tmp/pg_tde_test_keyring.per"}
2 | file-provider2 | file | {"path" : "/tmp/pg_tde_test_keyring2.per"}
id | name | type | options
----+----------------+------+--------------------------------------------
1 | file-provider | file | {"path" : "/tmp/pg_tde_test_keyring.per"}
2 | file-provider2 | file | {"path" : "/tmp/pg_tde_test_keyring2.per"}
(2 rows)

SELECT pg_tde_add_global_key_provider_file('file-keyring','/tmp/pg_tde_test_keyring.per');
Expand All @@ -72,8 +72,8 @@ SELECT pg_tde_add_global_key_provider_file('file-keyring2','/tmp/pg_tde_test_key

(1 row)

SELECT id, provider_name FROM pg_tde_list_all_global_key_providers();
id | provider_name
SELECT id, name FROM pg_tde_list_all_global_key_providers();
id | name
----+---------------
-4 | file-keyring
-5 | file-keyring2
Expand All @@ -82,8 +82,8 @@ SELECT id, provider_name FROM pg_tde_list_all_global_key_providers();
-- fails
SELECT pg_tde_delete_database_key_provider('file-provider');
ERROR: Can't delete a provider which is currently in use
SELECT id, provider_name FROM pg_tde_list_all_database_key_providers();
id | provider_name
SELECT id, name FROM pg_tde_list_all_database_key_providers();
id | name
----+----------------
1 | file-provider
2 | file-provider2
Expand All @@ -96,14 +96,14 @@ SELECT pg_tde_delete_database_key_provider('file-provider2');

(1 row)

SELECT id, provider_name FROM pg_tde_list_all_database_key_providers();
id | provider_name
SELECT id, name FROM pg_tde_list_all_database_key_providers();
id | name
----+---------------
1 | file-provider
(1 row)

SELECT id, provider_name FROM pg_tde_list_all_global_key_providers();
id | provider_name
SELECT id, name FROM pg_tde_list_all_global_key_providers();
id | name
----+---------------
-4 | file-keyring
-5 | file-keyring2
Expand All @@ -118,8 +118,8 @@ SELECT pg_tde_set_key_using_global_key_provider('test-db-key', 'file-keyring', f
-- fails
SELECT pg_tde_delete_global_key_provider('file-keyring');
ERROR: Can't delete a provider which is currently in use
SELECT id, provider_name FROM pg_tde_list_all_global_key_providers();
id | provider_name
SELECT id, name FROM pg_tde_list_all_global_key_providers();
id | name
----+---------------
-4 | file-keyring
-5 | file-keyring2
Expand All @@ -132,9 +132,9 @@ SELECT pg_tde_delete_global_key_provider('file-keyring2');

(1 row)

SELECT id, provider_name FROM pg_tde_list_all_global_key_providers();
id | provider_name
----+---------------
SELECT id, name FROM pg_tde_list_all_global_key_providers();
id | name
----+--------------
-4 | file-keyring
(1 row)

Expand Down
16 changes: 8 additions & 8 deletions contrib/pg_tde/pg_tde--1.0-rc.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
\echo Use "CREATE EXTENSION pg_tde" to load this file. \quit

-- Key Provider Management
CREATE FUNCTION pg_tde_add_database_key_provider(provider_type TEXT, provider_name TEXT, options JSON)
CREATE FUNCTION pg_tde_add_database_key_provider(type TEXT, name TEXT, options JSON)
RETURNS VOID
LANGUAGE C
AS 'MODULE_PATHNAME';
Expand Down Expand Up @@ -50,8 +50,8 @@ END;

CREATE FUNCTION pg_tde_list_all_database_key_providers
(OUT id INT,
OUT provider_name TEXT,
OUT provider_type TEXT,
OUT name TEXT,
OUT type TEXT,
OUT options JSON)
RETURNS SETOF RECORD
LANGUAGE C
Expand All @@ -60,16 +60,16 @@ REVOKE ALL ON FUNCTION pg_tde_list_all_database_key_providers() FROM PUBLIC;

CREATE FUNCTION pg_tde_list_all_global_key_providers
(OUT id INT,
OUT provider_name TEXT,
OUT provider_type TEXT,
OUT name TEXT,
OUT type TEXT,
OUT options JSON)
RETURNS SETOF RECORD
LANGUAGE C
AS 'MODULE_PATHNAME';
REVOKE ALL ON FUNCTION pg_tde_list_all_global_key_providers() FROM PUBLIC;

-- Global Tablespace Key Provider Management
CREATE FUNCTION pg_tde_add_global_key_provider(provider_type TEXT, provider_name TEXT, options JSON)
CREATE FUNCTION pg_tde_add_global_key_provider(type TEXT, name TEXT, options JSON)
RETURNS VOID
LANGUAGE C
AS 'MODULE_PATHNAME';
Expand Down Expand Up @@ -116,7 +116,7 @@ BEGIN ATOMIC
END;

-- Key Provider Management
CREATE FUNCTION pg_tde_change_database_key_provider(provider_type TEXT, provider_name TEXT, options JSON)
CREATE FUNCTION pg_tde_change_database_key_provider(type TEXT, name TEXT, options JSON)
RETURNS VOID
LANGUAGE C
AS 'MODULE_PATHNAME';
Expand Down Expand Up @@ -163,7 +163,7 @@ BEGIN ATOMIC
END;

-- Global Tablespace Key Provider Management
CREATE FUNCTION pg_tde_change_global_key_provider(provider_type TEXT, provider_name TEXT, options JSON)
CREATE FUNCTION pg_tde_change_global_key_provider(type TEXT, name TEXT, options JSON)
RETURNS VOID
LANGUAGE C
AS 'MODULE_PATHNAME';
Expand Down
2 changes: 1 addition & 1 deletion contrib/pg_tde/sql/default_principal_key.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ SELECT key_provider_id, key_provider_name, key_name

-- fails
SELECT pg_tde_delete_global_key_provider('file-provider');
SELECT id, provider_name FROM pg_tde_list_all_global_key_providers();
SELECT id, name FROM pg_tde_list_all_global_key_providers();

-- Should fail: no principal key for the database yet
SELECT key_provider_id, key_provider_name, key_name
Expand Down
12 changes: 6 additions & 6 deletions contrib/pg_tde/sql/key_provider.sql
View file
Open in desktop
< 8000 td id="diff-0421f941de22aa162e7361683363d77a8aa8cfaea5872de1542e4a6627c3cfaeR34" data-line-number="34" class="blob-num blob-num-context js-linkable-line-number js-blob-rnum">
Original file line number Diff line number Diff line change
Expand Up @@ -22,27 +22,27 @@ SELECT pg_tde_add_global_key_provider_file('file-keyring','/tmp/pg_tde_test_keyr

SELECT pg_tde_add_global_key_provider_file('file-keyring2','/tmp/pg_tde_test_keyring2.per');

SELECT id, provider_name FROM pg_tde_list_all_global_key_providers();
SELECT id, name FROM pg_tde_list_all_global_key_providers();

-- fails
SELECT pg_tde_delete_database_key_provider('file-provider');
SELECT id, provider_name FROM pg_tde_list_all_database_key_providers();
SELECT id, name FROM pg_tde_list_all_database_key_providers();

-- works
SELECT pg_tde_delete_database_key_provider('file-provider2');
SELECT id, provider_name FROM pg_tde_list_all_database_key_providers();
SELECT id, name FROM pg_tde_list_all_database_key_providers();

SELECT id, provider_name FROM pg_tde_list_all_global_key_providers();
SELECT id, name FROM pg_tde_list_all_global_key_providers();

SELECT pg_tde_set_key_using_global_key_provider('test-db-key', 'file-keyring', false);

-- fails
SELECT pg_tde_delete_global_key_provider('file-keyring');
SELECT id, provider_name FROM pg_tde_list_all_global_key_providers();
SELECT id, name FROM pg_tde_list_all_global_key_providers();

-- works
SELECT pg_tde_delete_global_key_provider('file-keyring2');
SELECT id, provider_name FROM pg_tde_list_all_global_key_providers();
SELECT id, name FROM pg_tde_list_all_global_key_providers();

-- Creating a file key provider fails if we can't open or create the file
SELECT pg_tde_add_database_key_provider_file('will-not-work','/cant-create-file-in-root.per');
Expand Down
18 changes: 9 additions & 9 deletions contrib/pg_tde/t/expected/change_key_provider.out
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ SELECT pg_tde_add_database_key_provider_file('file-vault', '/tmp/change_key_prov
(1 row)

SELECT * FROM pg_tde_list_all_database_key_providers();
id | provider_name | provider_type | options
----+---------------+---------------+---------------------------------------------
1 | file-vault | file | {"path" : "/tmp/change_key_provider_1.per"}
id | name | type | options
----+------------+------+---------------------------------------------
1 | file-vault | file | {"path" : "/tmp/change_key_provider_1.per"}
(1 row)

SELECT pg_tde_set_key_using_database_key_provider('test-key', 'file-vault');
Expand Down Expand Up @@ -46,9 +46,9 @@ SELECT pg_tde_change_database_key_provider_file('file-vault', '/tmp/change_key_p
(1 row)

SELECT * FROM pg_tde_list_all_database_key_providers();
id | provider_name | provider_type | options
----+---------------+---------------+---------------------------------------------
1 | file-vault | file | {"path" : "/tmp/change_key_provider_2.per"}
id | name | type | options
----+------------+------+---------------------------------------------
1 | file-vault | file | {"path" : "/tmp/change_key_provider_2.per"}
(1 row)

SELECT pg_tde_verify_key();
Expand Down Expand Up @@ -109,9 +109,9 @@ SELECT pg_tde_change_database_key_provider_file('file-vault', '/tmp/change_key_p
(1 row)

SELECT * FROM pg_tde_list_all_database_key_providers();
id | provider_name | provider_type | options
----+---------------+---------------+---------------------------------------------
1 | file-vault | file | {"path" : "/tmp/change_key_provider_1.per"}
id | name | type | options
----+------------+------+---------------------------------------------
1 | file-vault | file | {"path" : "/tmp/change_key_provider_1.per"}
(1 row)

SELECT pg_tde_verify_key();
Expand Down
20 changes: 10 additions & 10 deletions contrib/pg_tde/t/pg_tde_change_key_provider.pl
View file
Open in desktop
< 7A62 td class="blob-num blob-num-expandable" colspan="2"> Expand Down Expand Up
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,15 @@

is( $node->safe_psql(
'postgres',
q{SELECT provider_type FROM pg_tde_list_all_database_key_providers() WHERE provider_name = 'database-provider'}
q{SELECT type FROM pg_tde_list_all_database_key_providers() WHERE name = 'database-provider'}
),
'file',
'provider type is set to file');

$options = decode_json(
$node->safe_psql(
'postgres',
q{SELECT options FROM pg_tde_list_all_database_key_providers() WHERE provider_name = 'database-provider'}
q{SELECT options FROM pg_tde_list_all_database_key_providers() WHERE name = 'database-provider'}
));
is( $options->{path},
'/tmp/pg_tde_change_key_provider-database-2',
Expand All @@ -78,15 +78,15 @@

is( $node->safe_psql(
'postgres',
q{SELECT provider_type FROM pg_tde_list_all_database_key_providers() WHERE provider_name = 'database-provider'}
q{SELECT type FROM pg_tde_list_all_database_key_providers() WHERE name = 'database-provider'}
),
'vault-v2',
'provider type is set to vault-v2');

$options = decode_json(
$node->safe_psql(
'postgres',
q{SELECT options FROM pg_tde_list_all_database_key_providers() WHERE provider_name = 'database-provider'}
q{SELECT options FROM pg_tde_list_all_database_key_providers() WHERE name = 'database-provider'}
));
is( $options->{url},
'https://vault-server.example:8200/',
Expand Down Expand Up @@ -118,15 +118,15 @@

is( $node->safe_psql(
'postgres',
q{SELECT provider_type FROM pg_tde_list_all_database_key_providers() WHERE provider_name = 'database-provider'}
q{SELECT type FROM pg_tde_list_all_database_key_providers() WHERE name = 'database-provider'}
),
'vault-v2',
'provider type is set to vault-v2');

$options = decode_json(
$node->safe_psql(
'postgres',
q{SELECT options FROM pg_tde_list_all_database_key_providers() WHERE provider_name = 'database-provider'}
q{SELECT options FROM pg_tde_list_all_database_key_providers() WHERE name = 'database-provider'}
));
is( $options->{url},
'http://vault-server.example:8200/',
Expand Down Expand Up @@ -159,15 +159,15 @@

is( $node->safe_psql(
'postgres',
q{SELECT provider_type FROM pg_tde_list_all_database_key_providers() WHERE provider_name = 'database-provider'}
q{SELECT type FROM pg_tde_list_all_database_key_providers() WHERE name = 'database-provider'}
),
'kmip',
'provider type is set to kmip');

$options = decode_json(
$node->safe_psql(
'postgres',
q{SELECT options FROM pg_tde_list_all_database_key_providers() WHERE provider_name = 'database-provider'}
q{SELECT options FROM pg_tde_list_all_database_key_providers() WHERE name = 'database-provider'}
));
is($options->{host}, 'kmip-server.example',
'host is set correctly for kmip provider');
@@ -200,15 +200,15 @@

is( $node->safe_psql(
'postgres',
q{SELECT provider_type FROM pg_tde_list_all_global_key_providers() WHERE provider_name = 'global-provider'}
q{SELECT type FROM pg_tde_list_all_global_key_providers() WHERE name = 'global-provider'}
),
'vault-v2',
'provider type is set to vault-v2 for global provider');

$options = decode_json(
$node->safe_psql(
'postgres',
q{SELECT options FROM pg_tde_list_all_global_key_providers() WHERE provider_name = 'global-provider'}
q{SELECT options FROM pg_tde_list_all_global_key_providers() WHERE name = 'global-provider'}
));
is( $options->{url},
'http://vault-server.example:8200/',
Expand Down
0