dao.go

/*
 * Copyright (c) 2018. Abstrium SAS <team (at) pydio.com>
 * This file is part of Pydio Cells.
 *
 * Pydio Cells is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Pydio Cells is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with Pydio Cells.  If not, see <http://www.gnu.org/licenses/>.
 *
 * The latest code can be found at <https://pydio.com>.
 */

// Package dao provides abstraction of persistence layer used by pydio services.
package dao

import (
	"github.com/pydio/cells/common"
)

// DAO interface definition
type DAO interface {
	Init(common.ConfigValues) error
	GetConn() Conn
	SetConn(Conn)
	CloseConn() error
	Driver() string

	// Prefix is used to prevent collision between table names
	// in case this DAO accesses a shared DB.
	Prefix() string
}

type handler struct {
	conn   Conn
	driver string
	prefix string
}

// NewDAO returns a reference to a newly created struct that
// contains the necessary information to access a database.
// Prefix parameter is used to specify a prefix to avoid collision
// between table names in case this DAO accesses a shared DB: it thus
// will be an empty string in most of the cases.
func NewDAO(conn Conn, driver string, prefix string) DAO {
	return &handler{
		conn:   conn,
		driver: driver,
		prefix: prefix,
	}
}

func (h *handler) Init(c common.ConfigValues) error {
	return nil
}

func (h *handler) Driver() string {
	return h.driver
}

func (h *handler) Prefix() string {
	return h.prefix
}

// GetConn to the DB for the DAO
func (h *handler) GetConn() Conn {
	if h == nil {
		return nil
	}
	return h.conn
}

// SetConn assigns the db connection to the DAO
func (h *handler) SetConn(conn Conn) {
	h.conn = conn
}

// CloseConn closes the db connection
func (h *handler) CloseConn() error {
	return closeConn(h.conn)
}