README.md

GoGFAPI

A GoGFAPI is Go wrapper around libgfapi, a userspace C-library to access GlusterFS volumes. GoGAPI provides a Go standard library (os) like API to access files on GlusterFS volumes. More information on the API is available on godoc.org/github.com/gluster/gofapi/gfapi.

Note: GoGFAPI uses cgo to bind with libgfapi.

Important: Commit 83a4c9f12fec7d6e1112b5ebbd614a679940ad45 made changes to the volume.Init() function. The order of the function parameters was changed to support multiple volfile servers.

Using GoGFAPI

First ensure that libgfapi is installed on your system. For Fedora and CentOS (and other EL systems) install the glusterfs-api package.

Get GoGFAPI by doing a go get.

go get -u github.com/gluster/gogfapi/gfapi

Import github.com/gluster/gogfapi/gfapi into your program to use it.

A simple example,

package main

import "github.com/gluster/gogfapi/gfapi"

func main() {
	vol := &gfapi.Volume{}
	if err := vol.Init("testvol", "localhost"); err != nil {
		// handle error
	}

	if err := vol.Mount(); err != nil {
		// handle error
	}
	defer vol.Unmount()

	f, err := vol.Create("testfile")
	if err != nil {
		// handle error
	}
	defer f.Close()

	if _, err := f.Write([]byte("hello")); err != nil {
		// handle error
	}

	return
}