https://github.com/xyproto/simplehstore

:convenience_store: Easy way to use a PostgreSQL database (and the HSTORE feature) from Go
https://github.com/xyproto/simplehstore

go hashmap hstore key-value postgresql postgresql-database strings

Last synced: 11 months ago
JSON representation

:convenience_store: Easy way to use a PostgreSQL database (and the HSTORE feature) from Go

• Host: GitHub
• URL: https://github.com/xyproto/simplehstore
• Owner: xyproto
• License: bsd-3-clause
• Created: 2016-01-11T13:30:04.000Z (about 10 years ago)
• Default Branch: main
• Last Pushed: 2024-12-02T12:30:40.000Z (about 1 year ago)
• Last Synced: 2025-04-02T19:08:26.780Z (11 months ago)
• Topics: go, hashmap, hstore, key-value, postgresql, postgresql-database, strings
• Language: Go
• Homepage:
• Size: 385 KB
• Stars: 54
• Watchers: 4
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
simplehstore

===========

[![Build](https://github.com/xyproto/simplehstore/actions/workflows/test.yml/badge.svg)](https://github.com/xyproto/simplehstore/actions/workflows/test.yml)

[![GoDoc](https://godoc.org/github.com/xyproto/simplehstore?status.svg)](http://godoc.org/github.com/xyproto/simplehstore)

[![License](http://img.shields.io/badge/license-BSD-blue.svg?style=flat)](https://raw.githubusercontent.com/xyproto/simplehstore/master/LICENSE)

[![Go Report Card](https://goreportcard.com/badge/github.com/xyproto/simplehstore)](https://goreportcard.com/report/github.com/xyproto/simplehstore)

Easy way to use a PostgreSQL database (and the HSTORE feature) from Go.

Online API Documentation

------------------------

[godoc.org](http://godoc.org/github.com/xyproto/simplehstore)

Features and limitations

------------------------

* Requires PostgreSQL 9.1 or later.

* Requires Go 1.10 or later.

* Supports simple use of lists, hashmaps, sets and key/values.

* Deals mainly with strings.

* Uses the [pq](https://github.com/lib/pq) package.

* Modeled after [simpleredis](https://github.com/xyproto/simpleredis).

* Uses SQL queries with HSTORE for the KeyValue and HashMap types.

* Uses regular SQL for the List and Set types.

Sample usage

------------

~~~go

package main

import (

    "log"

    db "github.com/xyproto/simplehstore"

)

func main() {

    // Check if the local db service is up

    if err := db.TestConnection(); err != nil {

        log.Fatalln("Could not connect to local database. Is the service up and running?")

    }

    // Create a Host, connect to the local db server

    host := db.New()

    // Connecting to a different host/port

    //host := db.NewHost("server:5432/db")

    // Connect to a different db host/port, with a username and password

    // host := db.NewHost("username:password@server/db")

    // Close the connection when the function returns

    defer host.Close()

    // Create a list named "greetings"

    list, err := db.NewList(host, "greetings")

    if err != nil {

        log.Fatalln("Could not create list!")

    }

    // Add "hello" to the list, check if there are errors

    if list.Add("hello") != nil {

        log.Fatalln("Could not add an item to list!")

    }

    // Get the last item of the list

    if item, err := list.GetLast(); err != nil {

        log.Fatalln("Could not fetch the last item from the list!")

    } else {

        log.Println("The value of the stored item is:", item)

    }

    // Remove the list

    if list.Remove() != nil {

        log.Fatalln("Could not remove the list!")

    }

}

~~~

Testing

-------

* A PostgreSQL server must be up and running locally for `go test` to work, and a database named `test` must exist.

License, author and version

---------------------------

* License: BSD-3

* Author: Alexander F. Rødseth <xyproto@archlinux.org>

* Version: 1.8.3