Skip to content

Commit f10eae3

Browse files
committed
Clarify key deletion funcs description in docs
Key deletion fucntions don't delete anything as keys stored in external key management system. So these functions just remove keys from TDE.
1 parent 58153f9 commit f10eae3

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

contrib/pg_tde/documentation/docs/architecture/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -305,10 +305,10 @@ You can manage a default key with the following functions:
305305

306306
#### Delete a key
307307

308-
The `pg_tde_delete_key()` function removes the principal key for the current database. If the current database has any encrypted tables, and there isn’t a default principal key configured, it reports an error instead. If there are encrypted tables, but there’s also a default principal key, internal keys will be encrypted with the default key.
308+
The `pg_tde_delete_key()` function unsets the principal key for the current database. If the current database has any encrypted tables, and there isn’t a default principal key configured, it reports an error instead. If there are encrypted tables, but there’s also a default principal key, internal keys will be encrypted with the default key.
309309

310310
!!! note
311-
WAL keys **cannot** be deleted, as server keys are managed separately.
311+
WAL keys **cannot** be unset, as server keys are managed separately.
312312

313313
### Current key details
314314

contrib/pg_tde/documentation/docs/functions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -335,15 +335,15 @@ The `ensure_new_key` parameter instructs the function how to handle a principal
335335

336336
### pg_tde_delete_key
337337

338-
Deletes the principal key for the current database. If the current database has any encrypted tables, and there isn’t a default principal key configured, it reports an error instead. If there are encrypted tables, but there’s also a default principal key, internal keys will be encrypted with the default key.
338+
Unsets the principal key for the current database. If the current database has any encrypted tables, and there isn’t a default principal key configured, it reports an error instead. If there are encrypted tables, but there’s also a default principal key, internal keys will be encrypted with the default key.
339339

340340
```sql
341341
SELECT pg_tde_delete_key();
342342
```
343343

344344
### pg_tde_delete_default_key
345345

346-
Deletes default principal key. It's possible only if no database uses default principal key.
346+
Unsets default principal key. It's possible only if no database uses default principal key.
347347

348348
```sql
349349
SELECT pg_tde_delete_default_key();

0 commit comments

Comments
 (0)