package/storage
1
0
Fork 0
mirror of https://github.com/gofiber/storage.git synced 2025-10-08 18:11:23 +08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

🎨 update installation

Browse Source
This commit is contained in:
Fenny
2020-11-05 09:56:28 +01:00
parent fdf31cf4c0
commit 3799ccc4f5
7 changed files with 72 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
memcache/README.md
View File

@@ -4,6 +4,7 @@ A Memcache storage driver using [`bradfitz/gomemcache`](https://github.com/bradf
### Table of Contents
- [Signatures](#signatures)
- [Installation](#installation)
- [Examples](#examples)
- [Config](#config)
- [Default Config](#default-config)
@@ -14,6 +15,15 @@ func New(config ...Config) Storage
var ErrNotExist = errors.New("key does not exist")
```
### Installation
Memory is tested on the 2 last [Go versions](https://golang.org/dl/) with support for modules. So make sure to initialize one first if you didn't do that yet:
```bash
go mod init github.com/<user>/<repo>
```
And then install the memory implementation:
```bash
go get github.com/gofiber/storage/memory
```
### Examples
Import the storage package.

12
memory/README.md
View File

@@ -4,10 +4,12 @@ An in-memory storage driver.
### Table of Contents
- [Signatures](#signatures)
- [Installation](#installation)
- [Examples](#examples)
- [Config](#config)
- [Default Config](#default-config)
### Signatures
```go
func New(config ...Config) Storage
@@ -20,6 +22,16 @@ func (s *Storage) Delete(key string) error
func (s *Storage) Clear() error
```
### Installation
Memory is tested on the 2 last [Go versions](https://golang.org/dl/) with support for modules. So make sure to initialize one first if you didn't do that yet:
```bash
go mod init github.com/<user>/<repo>
```
And then install the memory implementation:
```bash
go get github.com/gofiber/storage/memory
```
### Examples
Import the storage package.
```go

10
mongodb/README.md
View File

@@ -4,6 +4,7 @@ A MongoDB storage driver using [mongodb/mongo-go-driver](https://github.com/mong
### Table of Contents
- [Signatures](#signatures)
- [Installation](#installation)
- [Examples](#examples)
- [Config](#config)
- [Default Config](#default-config)
@@ -19,6 +20,15 @@ func (s *Storage) Set(key string, val []byte, exp time.Duration) error
func (s *Storage) Delete(key string) error
func (s *Storage) Clear() error
```
### Installation
MongoDB is tested on the 2 last [Go versions](https://golang.org/dl/) with support for modules. So make sure to initialize one first if you didn't do that yet:
```bash
go mod init github.com/<user>/<repo>
```
And then install the mongodb implementation:
```bash
go get github.com/gofiber/storage/mongodb
```
### Examples
Import the storage package.

10
mysql/README.md
View File

@@ -4,6 +4,7 @@ A MySQL storage driver using `database/sql` and [go-sql-driver/mysql](https://gi
### Table of Contents
- [Signatures](#signatures)
- [Installation](#installation)
- [Examples](#examples)
- [Config](#config)
- [Default Config](#default-config)
@@ -19,6 +20,15 @@ func (s *Storage) Set(key string, val []byte, exp time.Duration) error
func (s *Storage) Delete(key string) error
func (s *Storage) Clear() error
```
### Installation
MySQL is tested on the 2 last [Go versions](https://golang.org/dl/) with support for modules. So make sure to initialize one first if you didn't do that yet:
```bash
go mod init github.com/<user>/<repo>
```
And then install the mysql implementation:
```bash
go get github.com/gofiber/storage/mysql
```
### Examples
Import the storage package.

10
postgres/README.md
View File

@@ -4,6 +4,7 @@ A Postgres storage driver using [lib/pq](https://github.com/lib/pq).
### Table of Contents
- [Signatures](#signatures)
- [Installation](#installation)
- [Examples](#examples)
- [Config](#config)
- [Default Config](#default-config)
@@ -19,6 +20,15 @@ func (s *Storage) Set(key string, val []byte, exp time.Duration) error
func (s *Storage) Delete(key string) error
func (s *Storage) Clear() error
```
### Installation
Postgres is tested on the 2 last [Go versions](https://golang.org/dl/) with support for modules. So make sure to initialize one first if you didn't do that yet:
```bash
go mod init github.com/<user>/<repo>
```
And then install the postgres implementation:
```bash
go get github.com/gofiber/storage/postgres
```
### Examples
Import the storage package.

10
redis/README.md
View File

@@ -4,6 +4,7 @@ A Redis storage driver using [go-redis/redis](github.com/go-redis/redis).
### Table of Contents
- [Signatures](#signatures)
- [Installation](#installation)
- [Examples](#examples)
- [Config](#config)
- [Default Config](#default-config)
@@ -19,6 +20,15 @@ func (s *Storage) Set(key string, val []byte, exp time.Duration) error
func (s *Storage) Delete(key string) error
func (s *Storage) Clear() error
```
### Installation
Redis is tested on the 2 last [Go versions](https://golang.org/dl/) with support for modules. So make sure to initialize one first if you didn't do that yet:
```bash
go mod init github.com/<user>/<repo>
```
And then install the redis implementation:
```bash
go get github.com/gofiber/storage/redis
```
### Examples
Import the storage package.

10
sqlite3/README.md
View File

@@ -4,6 +4,7 @@ A SQLite3 storage driver using [mattn/go-sqlite3](https://github.com/mattn/go-sq
### Table of Contents
- [Signatures](#signatures)
- [Installation](#installation)
- [Examples](#examples)
- [Config](#config)
- [Default Config](#default-config)
@@ -19,6 +20,15 @@ func (s *Storage) Set(key string, val []byte, exp time.Duration) error
func (s *Storage) Delete(key string) error
func (s *Storage) Clear() error
```
### Installation
SQLite3 is tested on the 2 last [Go versions](https://golang.org/dl/) with support for modules. So make sure to initialize one first if you didn't do that yet:
```bash
go mod init github.com/<user>/<repo>
```
And then install the sqlite3 implementation:
```bash
go get github.com/gofiber/storage/sqlite3
```
### Examples
Import the storage package.