From 339541a71b144da430e584230094c172aef3763d Mon Sep 17 00:00:00 2001 From: Adam Lamar Date: Thu, 10 Nov 2022 11:11:10 -0700 Subject: [PATCH] Rename to postgres_s3 --- docker/filer.toml | 4 +- ..._postgres3.toml => filer_postgres_s3.toml} | 0 .../{postgres3 => postgres_s3}/README.md | 12 ++--- .../postgres3_kvstore.go | 8 +-- .../postgres3_store.go | 51 +++++++++---------- .../postgres3_store_test.go | 2 +- weed/server/filer_server.go | 2 +- 7 files changed, 39 insertions(+), 40 deletions(-) rename docker/{filer_postgres3.toml => filer_postgres_s3.toml} (100%) rename weed/filer/{postgres3 => postgres_s3}/README.md (74%) rename weed/filer/{postgres3 => postgres_s3}/postgres3_kvstore.go (87%) rename weed/filer/{postgres3 => postgres_s3}/postgres3_store.go (83%) rename weed/filer/{postgres3 => postgres_s3}/postgres3_store_test.go (98%) diff --git a/docker/filer.toml b/docker/filer.toml index 216ea8d2f..c1c74a64e 100644 --- a/docker/filer.toml +++ b/docker/filer.toml @@ -1,3 +1,3 @@ -[leveldb3] +[rocksdb] enabled = true -dir = "/data/filer_leveldb3" +dir = "/data/filer_rocksdb" diff --git a/docker/filer_postgres3.toml b/docker/filer_postgres_s3.toml similarity index 100% rename from docker/filer_postgres3.toml rename to docker/filer_postgres_s3.toml diff --git a/weed/filer/postgres3/README.md b/weed/filer/postgres_s3/README.md similarity index 74% rename from weed/filer/postgres3/README.md rename to weed/filer/postgres_s3/README.md index 67c88e6b8..f612b29e0 100644 --- a/weed/filer/postgres3/README.md +++ b/weed/filer/postgres_s3/README.md @@ -1,6 +1,6 @@ -# postgres3 +# postgres_s3 -The `postgres3` filer implementation uses postgres-specific features and data structures to improve upon previous SQL implementations based on the `abstract_sql` module. +The `postgres_s3` filer implementation uses postgres-specific features and data structures to improve upon previous SQL implementations based on the `abstract_sql` module. Of note, the `postgres2` filer implementation may leak directory hierarchy metadata when frequent inserts and deletes are performed using the S3 API. If an application workload pattern creates directories, populates them temporarily, and then @@ -11,23 +11,23 @@ remains and places the burden of an unbounded number of unused rows on postgres. Seaweedfs provides the `-s3.allowEmptyFolder=false` CLI argument to automatically clean up orphaned directory entries, but this process necessarily races under high load and can cause unpredictable filer and postgres behavior. -To solve this problem, `postgres3` does the following: +To solve this problem, `postgres_s3` does the following: 1. One row in postgres _fully_ represents one object and its metadata 2. Insert, update, get, and delete operate on a single row 3. An array is stored of possible prefixes for each key 4. List requests leverage the prefixes to dynamically assemble directory entries using a complex `SELECT` statement -In order to efficiently query directory entries during list requests, `postgres3` uses special features of +In order to efficiently query directory entries during list requests, `postgres_s3` uses special features of postgres: * An int64 array field called `prefixes` with a hash of each prefix found for a specific key * GIN indexing that provides fast set membership information on array fields * Special functions `split_part` (text parsing) and `cardinality` (length of the array field) -`postgres3` uses automatic upsert capability with `ON CONFLICT ... UPDATE` so that insert and update are the same +`postgres_s3` uses automatic upsert capability with `ON CONFLICT ... UPDATE` so that insert and update are the same race-free operation. In the filer metadata tables, all objects start with `/`, causing prefix calculation to include the empty string (`""`). -For space and index optimization, `postgres3` does not store the root prefix in the `prefixes` array, and instead +For space and index optimization, `postgres_s3` does not store the root prefix in the `prefixes` array, and instead relies on the condition `cardinality(prefixes) < 1` to discover objects at the root directory. \ No newline at end of file diff --git a/weed/filer/postgres3/postgres3_kvstore.go b/weed/filer/postgres_s3/postgres3_kvstore.go similarity index 87% rename from weed/filer/postgres3/postgres3_kvstore.go rename to weed/filer/postgres_s3/postgres3_kvstore.go index 7709873b6..b799071de 100644 --- a/weed/filer/postgres3/postgres3_kvstore.go +++ b/weed/filer/postgres_s3/postgres3_kvstore.go @@ -1,4 +1,4 @@ -package postgres3 +package postgres_s3 /* * Copyright 2022 Splunk Inc. @@ -27,7 +27,7 @@ import ( "github.com/seaweedfs/seaweedfs/weed/filer/abstract_sql" ) -func (store *Postgres3Store) KvPut(ctx context.Context, key []byte, value []byte) error { +func (store *PostgresS3Store) KvPut(ctx context.Context, key []byte, value []byte) error { db, _, _, err := store.getTxOrDB(ctx, "", false) if err != nil { return fmt.Errorf("findDB: %v", err) @@ -42,7 +42,7 @@ func (store *Postgres3Store) KvPut(ctx context.Context, key []byte, value []byte return nil } -func (store *Postgres3Store) KvGet(ctx context.Context, key []byte) (value []byte, err error) { +func (store *PostgresS3Store) KvGet(ctx context.Context, key []byte) (value []byte, err error) { db, _, _, err := store.getTxOrDB(ctx, "", false) if err != nil { return nil, fmt.Errorf("findDB: %v", err) @@ -63,7 +63,7 @@ func (store *Postgres3Store) KvGet(ctx context.Context, key []byte) (value []byt return } -func (store *Postgres3Store) KvDelete(ctx context.Context, key []byte) error { +func (store *PostgresS3Store) KvDelete(ctx context.Context, key []byte) error { db, _, _, err := store.getTxOrDB(ctx, "", false) if err != nil { return fmt.Errorf("findDB: %v", err) diff --git a/weed/filer/postgres3/postgres3_store.go b/weed/filer/postgres_s3/postgres3_store.go similarity index 83% rename from weed/filer/postgres3/postgres3_store.go rename to weed/filer/postgres_s3/postgres3_store.go index 43ec9e174..7b41c8ad9 100644 --- a/weed/filer/postgres3/postgres3_store.go +++ b/weed/filer/postgres_s3/postgres3_store.go @@ -1,4 +1,4 @@ -package postgres3 +package postgres_s3 /* * Copyright 2022 Splunk Inc. @@ -76,29 +76,28 @@ var ( listEntryInclusivePattern string ) -var _ filer.BucketAware = (*Postgres3Store)(nil) +var _ filer.BucketAware = (*PostgresS3Store)(nil) func init() { - filer.Stores = append(filer.Stores, &Postgres3Store{}) + filer.Stores = append(filer.Stores, &PostgresS3Store{}) listEntryExclusivePattern = strings.ReplaceAll(listEntryQueryPattern, "__COMPARISON__", ">") listEntryInclusivePattern = strings.ReplaceAll(listEntryQueryPattern, "__COMPARISON__", ">=") } -type Postgres3Store struct { +type PostgresS3Store struct { DB *sql.DB SupportBucketTable bool dbs map[string]bool dbsLock sync.Mutex } -func (store *Postgres3Store) GetName() string { - return "postgres3" +func (store *PostgresS3Store) GetName() string { + return "postgres_s3" } -func (store *Postgres3Store) Initialize(configuration util.Configuration, prefix string) error { +func (store *PostgresS3Store) Initialize(configuration util.Configuration, prefix string) error { return store.initialize( - configuration.GetString(prefix+"createTable"), configuration.GetString(prefix+"username"), configuration.GetString(prefix+"password"), configuration.GetString(prefix+"hostname"), @@ -112,7 +111,7 @@ func (store *Postgres3Store) Initialize(configuration util.Configuration, prefix ) } -func (store *Postgres3Store) initialize(createTable, user, password, hostname string, port int, database, schema, sslmode string, maxIdle, maxOpen, maxLifetimeSeconds int) (err error) { +func (store *PostgresS3Store) initialize(user, password, hostname string, port int, database, schema, sslmode string, maxIdle, maxOpen, maxLifetimeSeconds int) (err error) { store.SupportBucketTable = true sqlUrl := fmt.Sprintf(CONNECTION_URL_PATTERN, hostname, port, sslmode) if user != "" { @@ -154,11 +153,11 @@ func (store *Postgres3Store) initialize(createTable, user, password, hostname st return nil } -func (store *Postgres3Store) CanDropWholeBucket() bool { +func (store *PostgresS3Store) CanDropWholeBucket() bool { return store.SupportBucketTable } -func (store *Postgres3Store) OnBucketCreation(bucket string) { +func (store *PostgresS3Store) OnBucketCreation(bucket string) { store.dbsLock.Lock() defer store.dbsLock.Unlock() @@ -170,7 +169,7 @@ func (store *Postgres3Store) OnBucketCreation(bucket string) { store.dbs[bucket] = true } -func (store *Postgres3Store) OnBucketDeletion(bucket string) { +func (store *PostgresS3Store) OnBucketDeletion(bucket string) { store.dbsLock.Lock() defer store.dbsLock.Unlock() @@ -182,7 +181,7 @@ func (store *Postgres3Store) OnBucketDeletion(bucket string) { delete(store.dbs, bucket) } -func (store *Postgres3Store) getTxOrDB(ctx context.Context, fullpath util.FullPath, isForChildren bool) (txOrDB abstract_sql.TxOrDB, bucket string, shortPath util.FullPath, err error) { +func (store *PostgresS3Store) getTxOrDB(ctx context.Context, fullpath util.FullPath, isForChildren bool) (txOrDB abstract_sql.TxOrDB, bucket string, shortPath util.FullPath, err error) { shortPath = fullpath bucket = abstract_sql.DEFAULT_TABLE @@ -233,7 +232,7 @@ func (store *Postgres3Store) getTxOrDB(ctx context.Context, fullpath util.FullPa return } -func (store *Postgres3Store) InsertEntry(ctx context.Context, entry *filer.Entry) error { +func (store *PostgresS3Store) InsertEntry(ctx context.Context, entry *filer.Entry) error { db, bucket, shortPath, err := store.getTxOrDB(ctx, entry.FullPath, false) if err != nil { return fmt.Errorf("findDB %s : %v", entry.FullPath, err) @@ -264,11 +263,11 @@ func (store *Postgres3Store) InsertEntry(ctx context.Context, entry *filer.Entry return nil } -func (store *Postgres3Store) UpdateEntry(ctx context.Context, entry *filer.Entry) error { +func (store *PostgresS3Store) UpdateEntry(ctx context.Context, entry *filer.Entry) error { return store.InsertEntry(ctx, entry) } -func (store *Postgres3Store) FindEntry(ctx context.Context, fullpath util.FullPath) (*filer.Entry, error) { +func (store *PostgresS3Store) FindEntry(ctx context.Context, fullpath util.FullPath) (*filer.Entry, error) { db, bucket, shortPath, err := store.getTxOrDB(ctx, fullpath, false) if err != nil { @@ -295,7 +294,7 @@ func (store *Postgres3Store) FindEntry(ctx context.Context, fullpath util.FullPa return entry, nil } -func (store *Postgres3Store) DeleteEntry(ctx context.Context, fullpath util.FullPath) error { +func (store *PostgresS3Store) DeleteEntry(ctx context.Context, fullpath util.FullPath) error { db, bucket, shortPath, err := store.getTxOrDB(ctx, fullpath, false) if err != nil { return fmt.Errorf("findDB %s : %v", fullpath, err) @@ -314,7 +313,7 @@ func (store *Postgres3Store) DeleteEntry(ctx context.Context, fullpath util.Full return nil } -func (store *Postgres3Store) DeleteFolderChildren(ctx context.Context, fullpath util.FullPath) (err error) { +func (store *PostgresS3Store) DeleteFolderChildren(ctx context.Context, fullpath util.FullPath) (err error) { db, bucket, shortPath, err := store.getTxOrDB(ctx, fullpath, true) if err != nil { return fmt.Errorf("findDB %s : %v", fullpath, err) @@ -347,11 +346,11 @@ func (store *Postgres3Store) DeleteFolderChildren(ctx context.Context, fullpath return nil } -func (store *Postgres3Store) ListDirectoryEntries(ctx context.Context, dirPath util.FullPath, startFileName string, includeStartFile bool, limit int64, eachEntryFunc filer.ListEachEntryFunc) (lastFileName string, err error) { +func (store *PostgresS3Store) ListDirectoryEntries(ctx context.Context, dirPath util.FullPath, startFileName string, includeStartFile bool, limit int64, eachEntryFunc filer.ListEachEntryFunc) (lastFileName string, err error) { return store.ListDirectoryPrefixedEntries(ctx, dirPath, startFileName, includeStartFile, limit, "", nil) } -func (store *Postgres3Store) ListDirectoryPrefixedEntries(ctx context.Context, dirPath util.FullPath, startFileName string, includeStartFile bool, limit int64, prefix string, eachEntryFunc filer.ListEachEntryFunc) (lastFileName string, err error) { +func (store *PostgresS3Store) ListDirectoryPrefixedEntries(ctx context.Context, dirPath util.FullPath, startFileName string, includeStartFile bool, limit int64, prefix string, eachEntryFunc filer.ListEachEntryFunc) (lastFileName string, err error) { db, bucket, shortPath, err := store.getTxOrDB(ctx, dirPath, true) if err != nil { return lastFileName, fmt.Errorf("findDB %s : %v", dirPath, err) @@ -423,7 +422,7 @@ func (store *Postgres3Store) ListDirectoryPrefixedEntries(ctx context.Context, d return lastFileName, nil } -func (store *Postgres3Store) BeginTransaction(ctx context.Context) (context.Context, error) { +func (store *PostgresS3Store) BeginTransaction(ctx context.Context) (context.Context, error) { tx, err := store.DB.BeginTx(ctx, &sql.TxOptions{ Isolation: sql.LevelReadCommitted, ReadOnly: false, @@ -435,25 +434,25 @@ func (store *Postgres3Store) BeginTransaction(ctx context.Context) (context.Cont return context.WithValue(ctx, "tx", tx), nil } -func (store *Postgres3Store) CommitTransaction(ctx context.Context) error { +func (store *PostgresS3Store) CommitTransaction(ctx context.Context) error { if tx, ok := ctx.Value("tx").(*sql.Tx); ok { return tx.Commit() } return nil } -func (store *Postgres3Store) RollbackTransaction(ctx context.Context) error { +func (store *PostgresS3Store) RollbackTransaction(ctx context.Context) error { if tx, ok := ctx.Value("tx").(*sql.Tx); ok { return tx.Rollback() } return nil } -func (store *Postgres3Store) Shutdown() { +func (store *PostgresS3Store) Shutdown() { store.DB.Close() } -func (store *Postgres3Store) CreateTable(ctx context.Context, bucket string) error { +func (store *PostgresS3Store) CreateTable(ctx context.Context, bucket string) error { _, err := store.DB.ExecContext(ctx, fmt.Sprintf(createTablePattern, bucket)) if err != nil { return fmt.Errorf("create bucket table: %v", err) @@ -466,7 +465,7 @@ func (store *Postgres3Store) CreateTable(ctx context.Context, bucket string) err return err } -func (store *Postgres3Store) deleteTable(ctx context.Context, bucket string) error { +func (store *PostgresS3Store) deleteTable(ctx context.Context, bucket string) error { if !store.SupportBucketTable { return nil } diff --git a/weed/filer/postgres3/postgres3_store_test.go b/weed/filer/postgres_s3/postgres3_store_test.go similarity index 98% rename from weed/filer/postgres3/postgres3_store_test.go rename to weed/filer/postgres_s3/postgres3_store_test.go index 89d7d4ef1..67dcd8743 100644 --- a/weed/filer/postgres3/postgres3_store_test.go +++ b/weed/filer/postgres_s3/postgres3_store_test.go @@ -1,4 +1,4 @@ -package postgres3 +package postgres_s3 /* * Copyright 2022 Splunk Inc. diff --git a/weed/server/filer_server.go b/weed/server/filer_server.go index aec36d0a9..55d5fa223 100644 --- a/weed/server/filer_server.go +++ b/weed/server/filer_server.go @@ -34,7 +34,7 @@ import ( _ "github.com/seaweedfs/seaweedfs/weed/filer/mysql2" _ "github.com/seaweedfs/seaweedfs/weed/filer/postgres" _ "github.com/seaweedfs/seaweedfs/weed/filer/postgres2" - _ "github.com/seaweedfs/seaweedfs/weed/filer/postgres3" + _ "github.com/seaweedfs/seaweedfs/weed/filer/postgres_s3" _ "github.com/seaweedfs/seaweedfs/weed/filer/redis" _ "github.com/seaweedfs/seaweedfs/weed/filer/redis2" _ "github.com/seaweedfs/seaweedfs/weed/filer/redis3"