github.com/go-kivik/kivik/v4@v4.3.2/x/memorydb/README.md (about)

     1  [![Go Reference](https://pkg.go.dev/badge/github.com/go-kivik/kivik/v4/x/memorydb.svg)](https://pkg.go.dev/github.com/go-kivik/kivik/v4/x/memorydb)
     2  
     3  # Kivik MemoryDB
     4  
     5  Experimental memory driver for [Kivik](https://github.com/go-kivik/kivik).
     6  
     7  This driver stores documents in memory only, and is intended for testing purposes only. Not all Kivik features are or will be supported. This package is still under active development.
     8  
     9  ## Usage
    10  
    11  This package provides an implementation of the
    12  [`github.com/go-kivik/kivik/driver`](http://pkg.go.dev/github.com/go-kivik/kivik/v4/driver)
    13  interface. You must import the driver and can then use the full
    14  [`Kivik`](http://pkg.go.dev/github.com/go-kivik/kivik/v4) API.
    15  
    16  ```go
    17  package main
    18  
    19  import (
    20      "context"
    21  
    22      "github.com/go-kivik/kivik/v4"
    23      _ "github.com/go-kivik/kivik/v4/x/memorydb" // The Memory driver
    24  )
    25  
    26  func main() {
    27      client, err := kivik.New(context.TODO(), "memory", "")
    28      // ...
    29  }
    30  ```
    31  
    32  ## License
    33  
    34  This software is released under the terms of the Apache 2.0 license. See
    35  LICENCE.md, or read the [full license](http://www.apache.org/licenses/LICENSE-2.0).