PG-1457 Renaming

Author: artemgavrilov

ci_scripts/backup/pg_basebackup_test.sh

@@ -104,8 +104,8 @@ setup_tde_heap(){
     sudo -u "$PG_USER" psql -p $PG_PORT -c "DROP DATABASE IF EXISTS $DB_NAME;"
     sudo -u "$PG_USER" psql -p $PG_PORT -c "CREATE DATABASE $DB_NAME;"
     sudo -u "$PG_USER" psql -d "$DB_NAME" -p "$PG_PORT" -c "CREATE EXTENSION IF NOT EXISTS pg_tde;"
-    sudo -u "$PG_USER" psql -d "$DB_NAME" -p "$PG_PORT" -c "SELECT pg_tde_add_key_provider_file('file-vault','$KEYLOCATION');"
-    sudo -u "$PG_USER" psql -d "$DB_NAME" -p "$PG_PORT" -c "SELECT pg_tde_set_principal_key('test-db-master-key','file-vault');"
+    sudo -u "$PG_USER" psql -d "$DB_NAME" -p "$PG_PORT" -c "SELECT pg_tde_add_database_key_provider_file('file-vault','$KEYLOCATION');"
+    sudo -u "$PG_USER" psql -d "$DB_NAME" -p "$PG_PORT" -c "SELECT pg_tde_set_principal_key_using_database_key_provider('test-db-master-key','file-vault');"
     sudo -u "$PG_USER" psql -p $PG_PORT -c "ALTER DATABASE $DB_NAME SET default_table_access_method='tde_heap';"
     sudo -u "$PG_USER" psql -p $PG_PORT -c "SELECT pg_reload_conf();"
 }

ci_scripts/tde_setup.sql

@@ -1,4 +1,4 @@
 CREATE SCHEMA IF NOT EXISTS tde;
 CREATE EXTENSION IF NOT EXISTS pg_tde SCHEMA tde;
-SELECT pg_tde_add_key_provider_file('reg_file-vault', '/tmp/pg_tde_test_keyring.per');
-SELECT pg_tde_set_principal_key('test-db-principal-key', 'reg_file-vault');
+SELECT pg_tde_add_database_key_provider_file('reg_file-vault', '/tmp/pg_tde_test_keyring.per');
+SELECT pg_tde_set_principal_key_using_database_key_provider('test-db-principal-key', 'reg_file-vault');

contrib/pg_tde/README.md

@@ -119,25 +119,25 @@ _See [Make Builds for Developers](https://github.com/percona/pg_tde/wiki/Make-bu
 
         ```sql
         -- For Vault-V2 key provider
-        -- pg_tde_add_key_provider_vault_v2(provider_name, vault_token, vault_url, vault_mount_path, vault_ca_path)
-        SELECT pg_tde_add_key_provider_vault_v2(
+        -- pg_tde_add_database_key_provider_vault_v2(provider_name, vault_token, vault_url, vault_mount_path, vault_ca_path)
+        SELECT pg_tde_add_database_key_provider_vault_v2(
             'vault-provider',
             json_object( 'type' VALUE 'remote', 'url' VALUE 'http://localhost:8888/token' ),
             json_object( 'type' VALUE 'remote', 'url' VALUE 'http://localhost:8888/url' ),
             to_json('secret'::text), NULL);
 
         -- For File key provider
-        -- pg_tde_add_key_provider_file(provider_name, file_path);
-        SELECT pg_tde_add_key_provider_file('file','/tmp/pgkeyring');
+        -- pg_tde_add_database_key_provider_file(provider_name, file_path);
+        SELECT pg_tde_add_database_key_provider_file('file','/tmp/pgkeyring');
         ```
 
         **Note: The `File` provided is intended for development and stores the keys unencrypted in the specified data file.**
 
    5. Set the principal key for the database using the `pg_tde_set_principal_key` function.
 
         ```sql
-        -- pg_tde_set_principal_key(principal_key_name, provider_name);
-        SELECT pg_tde_set_principal_key('my-principal-key','file');
+        -- pg_tde_set_principal_key_using_database_key_provider(principal_key_name, provider_name);
+        SELECT pg_tde_set_principal_key_using_database_key_provider('my-principal-key','file');
         ```
    
    6. Specify `tde_heap_basic` access method during table creation

contrib/pg_tde/documentation/docs/external-parameters.md

@@ -15,7 +15,7 @@ To use the file provider with a file location specified by the `remote` method,
 use the following command:
 
 ```
-SELECT pg_tde_add_key_provider_file(
+SELECT pg_tde_add_database_key_provider_file(
     'file-provider', 
     json_object( 'type' VALUE 'remote', 'url' VALUE 'http://localhost:8888/hello' )
     );"
@@ -24,7 +24,7 @@ SELECT pg_tde_add_key_provider_file(
 Or to use the `file` method, use the following command:
 
 ```
-SELECT pg_tde_add_key_provider_file(
+SELECT pg_tde_add_database_key_provider_file(
     'file-provider', 
     json_object( 'type' VALUE 'remote', 'path' VALUE '/tmp/datafile-location' )
     );"

contrib/pg_tde/documentation/docs/functions.md

@@ -90,7 +90,7 @@ The Vault provider connects to a HashiCorp Vault or an OpenBao server, and store
 Use the following functions to add the Vault provider:
 
 ```
-SELECT pg_tde_add_key_provider_vault_v2('provider-name','secret_token','url','mount','ca_path');
+SELECT pg_tde_add_database_key_provider_vault_v2('provider-name','secret_token','url','mount','ca_path');
 SELECT pg_tde_add_global_key_provider_vault_v2('provider-name','secret_token','url','mount','ca_path');
 ```
 
@@ -121,7 +121,7 @@ The KMIP provider uses a remote KMIP server.
 Use these functions to add a KMIP provider: 
 
 ```
-SELECT pg_tde_add_key_provider_kmip('provider-name','kmip-addr', `port`, '/path_to/server_certificate.pem', '/path_to/client_key.pem');
+SELECT pg_tde_add_database_key_provider_kmip('provider-name','kmip-addr', `port`, '/path_to/server_certificate.pem', '/path_to/client_key.pem');
 SELECT pg_tde_add_global_key_provider_kmip('provider-name','kmip-addr', `port`, '/path_to/server_certificate.pem', '/path_to/client_key.pem');
 ```
 
@@ -156,7 +156,7 @@ This function is intended for development or quick testing, and stores the keys
 Add a local keyfile provider:
 
 ```
-SELECT pg_tde_add_key_provider_file('provider-name','/path/to/the/key/provider/data.file');
+SELECT pg_tde_add_database_key_provider_file('provider-name','/path/to/the/key/provider/data.file');
 SELECT pg_tde_add_global_key_provider_file('provider-name','/path/to/the/key/provider/data.file');
 ```
 
@@ -178,7 +178,7 @@ All parameters can be either strings, or JSON objects [referencing remote parame
 
 These functions delete an existing provider in the current database or in the global scope:
 
-* `pg_tde_delete_key_provider('provider-name)`
+* `pg_tde_delete_database_key_provider('provider-name)`
 * `pg_tde_delete_global_key_provider('provider-name)`
 
 You can only delete key providers that are not currently in use. An error is returned if the current principal key is using the provider you are trying to delete.
@@ -189,7 +189,7 @@ If the use of global key providers is enabled via the `pg_tde.inherit_global` GU
 
 These functions list the details of all key providers for the current database or for the global scope, including all configuration values:
 
-* `pg_tde_list_all_key_providers()`
+* `pg_tde_list_all_database_key_providers()`
 * `pg_tde_list_all_global_key_providers()`
 
 **All configuration values include possibly sensitive values, such as passwords. Never specify these directly, use the remote configuration option instead.**

contrib/pg_tde/documentation/docs/multi-tenant-setup.md

@@ -61,7 +61,7 @@ You must do these steps for every database where you have created the extension.
         For testing purposes, you can use the PyKMIP server which enables you to set up required certificates. To use a real KMIP server, make sure to obtain the valid certificates issued by the key management appliance. 
 
         ```
-        SELECT pg_tde_add_key_provider_kmip('provider-name','kmip-addr', 5696, '/path_to/server_certificate.pem', '/path_to/client_key.pem');
+        SELECT pg_tde_add_database_key_provider_kmip('provider-name','kmip-addr', 5696, '/path_to/server_certificate.pem', '/path_to/client_key.pem');
         ```
 
         where:
@@ -75,15 +75,15 @@ You must do these steps for every database where you have created the extension.
         <i warning>:material-information: Warning:</i> This example is for testing purposes only:
 
         ```
-        SELECT pg_tde_add_key_provider_kmip('kmip','127.0.0.1', 5696, '/tmp/server_certificate.pem', '/tmp/client_key_jane_doe.pem');
+        SELECT pg_tde_add_database_key_provider_kmip('kmip','127.0.0.1', 5696, '/tmp/server_certificate.pem', '/tmp/client_key_jane_doe.pem');
         ```
 
     === "With HashiCorp Vault"
 
         The Vault server setup is out of scope of this document.
 
         ```sql
-        SELECT pg_tde_add_key_provider_vault_v2('provider-name','root_token','url','mount','ca_path');
+        SELECT pg_tde_add_database_key_provider_vault_v2('provider-name','root_token','url','mount','ca_path');
         ``` 
 
         where: 
@@ -104,20 +104,20 @@ You must do these steps for every database where you have created the extension.
         This setup is intended for development and stores the keys unencrypted in the specified data file.    
 
         ```sql
-        SELECT pg_tde_add_key_provider_file('provider-name','/path/to/the/keyring/data.file');
+        SELECT pg_tde_add_database_key_provider_file('provider-name','/path/to/the/keyring/data.file');
         ```
 
 	    <i warning>:material-information: Warning:</i> This example is for testing purposes only:
 
 	    ```sql
-	    SELECT pg_tde_add_key_provider_file('file-keyring','/tmp/pg_tde_test_local_keyring.per');
+	    SELECT pg_tde_add_database_key_provider_file('file-keyring','/tmp/pg_tde_test_local_keyring.per');
 	    ```
        
        
 2. Add a principal key
 
     ```sql
-    SELECT pg_tde_set_principal_key('name-of-the-principal-key', 'provider-name','ensure_new_key');
+    SELECT pg_tde_set_principal_key_using_database_key_provider('name-of-the-principal-key', 'provider-name','ensure_new_key');
     ```
 
     where:
@@ -129,7 +129,7 @@ You must do these steps for every database where you have created the extension.
     <i warning>:material-information: Warning:</i> This example is for testing purposes only:
 
     ```sql
-    SELECT pg_tde_set_principal_key('test-db-master-key','file-vault','ensure_new_key');
+    SELECT pg_tde_set_principal_key_using_database_key_provider('test-db-master-key','file-vault','ensure_new_key');
     ```
 
     The key is auto-generated.

contrib/pg_tde/documentation/docs/setup.md

@@ -123,7 +123,7 @@ Load the `pg_tde` at startup time. The extension requires additional shared memo
     <i warning>:material-information: Warning:</i> This example is for testing purposes only. Replace the key name and provider name with your values:
 
     ```sql
-    SELECT pg_tde_set_principal_key_global_provider('test-db-master-key','file-vault','ensure_new_key');
+    SELECT pg_tde_set_principal_key_using_global_key_provider('test-db-master-key','file-vault','ensure_new_key');
     ```
 
     The key is auto-generated.

contrib/pg_tde/expected/alter_index.out

@@ -1,15 +1,15 @@
 \set tde_am tde_heap
 \i sql/alter_index.inc
 CREATE EXTENSION IF NOT EXISTS pg_tde;
-SELECT pg_tde_add_key_provider_file('file-vault','/tmp/pg_tde_test_keyring.per');
- pg_tde_add_key_provider_file 
-------------------------------
-                            1
+SELECT pg_tde_add_database_key_provider_file('file-vault','/tmp/pg_tde_test_keyring.per');
+ pg_tde_add_database_key_provider_file 
+---------------------------------------
+                                     1
 (1 row)
 
-SELECT pg_tde_set_principal_key('test-db-principal-key','file-vault');
- pg_tde_set_principal_key 
---------------------------
+SELECT pg_tde_set_principal_key_using_database_key_provider('test-db-principal-key','file-vault');
+ pg_tde_set_principal_key_using_database_key_provider 
+------------------------------------------------------
  t
 (1 row)
 

contrib/pg_tde/expected/alter_index_basic.out

@@ -1,15 +1,15 @@
 \set tde_am tde_heap_basic
 \i sql/alter_index.inc
 CREATE EXTENSION IF NOT EXISTS pg_tde;
-SELECT pg_tde_add_key_provider_file('file-vault','/tmp/pg_tde_test_keyring.per');
- pg_tde_add_key_provider_file 
-------------------------------
-                            1
+SELECT pg_tde_add_database_key_provider_file('file-vault','/tmp/pg_tde_test_keyring.per');
+ pg_tde_add_database_key_provider_file 
+---------------------------------------
+                                     1
 (1 row)
 
-SELECT pg_tde_set_principal_key('test-db-principal-key','file-vault');
- pg_tde_set_principal_key 
---------------------------
+SELECT pg_tde_set_principal_key_using_database_key_provider('test-db-principal-key','file-vault');
+ pg_tde_set_principal_key_using_database_key_provider 
+------------------------------------------------------
  t
 (1 row)
 

contrib/pg_tde/expected/cache_alloc.out

@@ -1,15 +1,15 @@
 -- We test cache so AM doesn't matter
 -- Just checking there are no mem debug WARNINGs during the cache population
 CREATE EXTENSION IF NOT EXISTS pg_tde;
-SELECT pg_tde_add_key_provider_file('file-vault','/tmp/pg_tde_test_keyring.per');
- pg_tde_add_key_provider_file 
-------------------------------
-                            1
+SELECT pg_tde_add_database_key_provider_file('file-vault','/tmp/pg_tde_test_keyring.per');
+ pg_tde_add_database_key_provider_file 
+---------------------------------------
+                                     1
 (1 row)
 
-SELECT pg_tde_set_principal_key('test-db-principal-key','file-vault');
- pg_tde_set_principal_key 
---------------------------
+SELECT pg_tde_set_principal_key_using_database_key_provider('test-db-principal-key','file-vault');
+ pg_tde_set_principal_key_using_database_key_provider 
+------------------------------------------------------
  t
 (1 row)
 

contrib/pg_tde/expected/change_access_method.out

@@ -1,15 +1,15 @@
 \set tde_am tde_heap
 \i sql/change_access_method.inc
 CREATE EXTENSION IF NOT EXISTS pg_tde;
-SELECT pg_tde_add_key_provider_file('file-vault','/tmp/pg_tde_test_keyring.per');
- pg_tde_add_key_provider_file 
-------------------------------
-                            1
+SELECT pg_tde_add_database_key_provider_file('file-vault','/tmp/pg_tde_test_keyring.per');
+ pg_tde_add_database_key_provider_file 
+---------------------------------------
+                                     1
 (1 row)
 
-SELECT pg_tde_set_principal_key('test-db-principal-key','file-vault');
- pg_tde_set_principal_key 
---------------------------
+SELECT pg_tde_set_principal_key_using_database_key_provider('test-db-principal-key','file-vault');
+ pg_tde_set_principal_key_using_database_key_provider 
+------------------------------------------------------
  t
 (1 row)
 

contrib/pg_tde/expected/change_access_method_basic.out

@@ -1,15 +1,15 @@
 \set tde_am tde_heap_basic
 \i sql/change_access_method.inc
 CREATE EXTENSION IF NOT EXISTS pg_tde;
-SELECT pg_tde_add_key_provider_file('file-vault','/tmp/pg_tde_test_keyring.per');
- pg_tde_add_key_provider_file 
-------------------------------
-                            1
+SELECT pg_tde_add_database_key_provider_file('file-vault','/tmp/pg_tde_test_keyring.per');
+ pg_tde_add_database_key_provider_file 
+---------------------------------------
+                                     1
 (1 row)
 
-SELECT pg_tde_set_principal_key('test-db-principal-key','file-vault');
- pg_tde_set_principal_key 
---------------------------
+SELECT pg_tde_set_principal_key_using_database_key_provider('test-db-principal-key','file-vault');
+ pg_tde_set_principal_key_using_database_key_provider 
+------------------------------------------------------
  t
 (1 row)
 

contrib/pg_tde/expected/delete_key_provider.out

@@ -2,71 +2,71 @@ CREATE EXTENSION IF NOT EXISTS pg_tde;
 SELECT  * FROM pg_tde_principal_key_info();
 ERROR:  Principal key does not exists for the database
 HINT:  Use set_principal_key interface to set the principal key
-SELECT pg_tde_add_key_provider_file('file-provider','/tmp/pg_tde_test_keyring.per');
- pg_tde_add_key_provider_file 
-------------------------------
-                            1
+SELECT pg_tde_add_database_key_provider_file('file-provider','/tmp/pg_tde_test_keyring.per');
+ pg_tde_add_database_key_provider_file 
+---------------------------------------
+                                     1
 (1 row)
 
-SELECT * FROM pg_tde_list_all_key_providers();
+SELECT * FROM pg_tde_list_all_database_key_providers();
  id | provider_name | provider_type |                          options                           
 ----+---------------+---------------+------------------------------------------------------------
   1 | file-provider | file          | {"type" : "file", "path" : "/tmp/pg_tde_test_keyring.per"}
 (1 row)
 
-SELECT pg_tde_delete_key_provider('file-provider');
- pg_tde_delete_key_provider 
-----------------------------
+SELECT pg_tde_delete_database_key_provider('file-provider');
+ pg_tde_delete_database_key_provider 
+-------------------------------------
 
 (1 row)
 
-SELECT * FROM pg_tde_list_all_key_providers();
+SELECT * FROM pg_tde_list_all_database_key_providers();
  id | provider_name | provider_type | options 
 ----+---------------+---------------+---------
 (0 rows)
 
-SELECT pg_tde_add_key_provider_file('file-provider','/tmp/pg_tde_test_keyring.per');
- pg_tde_add_key_provider_file 
-------------------------------
-                            2
+SELECT pg_tde_add_database_key_provider_file('file-provider','/tmp/pg_tde_test_keyring.per');
+ pg_tde_add_database_key_provider_file 
+---------------------------------------
+                                     2
 (1 row)
 
-SELECT * FROM pg_tde_list_all_key_providers();
+SELECT * FROM pg_tde_list_all_database_key_providers();
  id | provider_name | provider_type |                          options                           
 ----+---------------+---------------+------------------------------------------------------------
   2 | file-provider | file          | {"type" : "file", "path" : "/tmp/pg_tde_test_keyring.per"}
 (1 row)
 
-SELECT pg_tde_delete_key_provider('file-provider');
- pg_tde_delete_key_provider 
-----------------------------
+SELECT pg_tde_delete_database_key_provider('file-provider');
+ pg_tde_delete_database_key_provider 
+-------------------------------------
 
 (1 row)
 
-SELECT * FROM pg_tde_list_all_key_providers();
+SELECT * FROM pg_tde_list_all_database_key_providers();
  id | provider_name | provider_type | options 
 ----+---------------+---------------+---------
 (0 rows)
 
-SELECT pg_tde_add_key_provider_file('file-provider','/tmp/pg_tde_test_keyring.per');
- pg_tde_add_key_provider_file 
-------------------------------
-                            3
+SELECT pg_tde_add_database_key_provider_file('file-provider','/tmp/pg_tde_test_keyring.per');
+ pg_tde_add_database_key_provider_file 
+---------------------------------------
+                                     3
 (1 row)
 
-SELECT * FROM pg_tde_list_all_key_providers();
+SELECT * FROM pg_tde_list_all_database_key_providers();
  id | provider_name | provider_type |                          options                           
 ----+---------------+---------------+------------------------------------------------------------
   3 | file-provider | file          | {"type" : "file", "path" : "/tmp/pg_tde_test_keyring.per"}
 (1 row)
 
-SELECT pg_tde_delete_key_provider('file-provider');
- pg_tde_delete_key_provider 
-----------------------------
+SELECT pg_tde_delete_database_key_provider('file-provider');
+ pg_tde_delete_database_key_provider 
+-------------------------------------
 
 (1 row)
 
-SELECT * FROM pg_tde_list_all_key_providers();
+SELECT * FROM pg_tde_list_all_database_key_providers();
  id | provider_name | provider_type | options 
 ----+---------------+---------------+---------
 (0 rows)