Explorar el Código

document Cockroach driver name

Nicola Murino hace 4 años
padre
commit
5cd27ce529

+ 1 - 1
.github/workflows/development.yml

@@ -270,7 +270,7 @@ jobs:
           go test -v -p 1 -timeout 10m ./... -covermode=atomic
           docker stop crdb
         env:
-          SFTPGO_DATA_PROVIDER__DRIVER: cockroach
+          SFTPGO_DATA_PROVIDER__DRIVER: cockroachdb
           SFTPGO_DATA_PROVIDER__NAME: sftpgo
           SFTPGO_DATA_PROVIDER__HOST: localhost
           SFTPGO_DATA_PROVIDER__PORT: 26257

+ 1 - 1
dataprovider/dataprovider.go

@@ -62,7 +62,7 @@ const (
 	// MemoryDataProviderName defines the name for memory provider
 	MemoryDataProviderName = "memory"
 	// CockroachDataProviderName defines the for CockroachDB provider
-	CockroachDataProviderName = "cockroach"
+	CockroachDataProviderName = "cockroachdb"
 	// DumpVersion defines the version for the dump.
 	// For restore/load we support the current version and the previous one
 	DumpVersion = 7

+ 1 - 1
docs/full-configuration.md

@@ -154,7 +154,7 @@ The configuration file contains the following sections:
     - `expiration_time`, integer. Expiration time, in minutes, for the cached users. 0 means unlimited. Default: 0.
     - `max_size`, integer. Maximum number of users to cache. 0 means unlimited. Default: 50.
 - **"data_provider"**, the configuration for the data provider
-  - `driver`, string. Supported drivers are `sqlite`, `mysql`, `postgresql`, `bolt`, `memory`
+  - `driver`, string. Supported drivers are `sqlite`, `mysql`, `postgresql`, `cockroachdb`, `bolt`, `memory`
   - `name`, string. Database name. For driver `sqlite` this can be the database name relative to the config dir or the absolute path to the SQLite database. For driver `memory` this is the (optional) path relative to the config dir or the absolute path to the provider dump, obtained using the `dumpdata` REST API, to load. This dump will be loaded at startup and can be reloaded on demand sending a `SIGHUP` signal on Unix based systems and a `paramchange` request to the running service on Windows. The `memory` provider will not modify the provided file so quota usage and last login will not be persisted. If you plan to use a SQLite database over a `cifs` network share (this is not recommended in general) you must use the `nobrl` mount option otherwise you will get the `database is locked` error. Some users reported that the `bolt` provider works fine over `cifs` shares.
   - `host`, string. Database host. Leave empty for drivers `sqlite`, `bolt` and `memory`
   - `port`, integer. Database port. Leave empty for drivers `sqlite`, `bolt` and `memory`