Skip to content

Commit 126f0ae

Browse files
committed
chore(stac-db): Add comment to code
1 parent d77b578 commit 126f0ae

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

lib/database/index.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ export class PgStacDatabase extends Construct {
8686

8787
return {
8888
maxConnections: `${maxConnections}`,
89-
sharedBuffers: `${sharedBuffers / 8}`,
89+
sharedBuffers: `${sharedBuffers / 8}`, // Represented in 8kb blocks
9090
effectiveCacheSize: `${effectiveCacheSize}`,
9191
workMem: `${workMem}`,
9292
maintenanceWorkMem: `${maintenanceWorkMem}`,
@@ -112,9 +112,9 @@ export interface DatabaseParameters {
112112
readonly maxConnections: string;
113113

114114
/**
115-
* Note, should be represented in units of 8KB
116-
*
117-
* @default - 25% of instance memory
115+
* Note: This value is measured in 8KB blocks.
116+
*
117+
* @default '{DBInstanceClassMemory/32768}' 25% of instance memory, ie `{(DBInstanceClassMemory/(1024*8)) * 0.25}`
118118
*/
119119
readonly sharedBuffers: string;
120120

0 commit comments

Comments
 (0)