Hydra

A Go library designed to dynamically hydrate Go structs with data from a variety of databases, offering flexibility and ease for database integration in software development.

Overview

Hydra is a Go library designed to dynamically hydrate Go structs with data from a variety of databases. The library supports multiple databases, including MySQL, PostgreSQL, SQLite, Microsoft SQL Server, Oracle, MariaDB, and CockroachDB. Simply apply hydra.Hydratable to your struct and add hydra tags, it automatically fills struct fields with data fetched from database queries.


package main

import (
    "database/sql"
    "github.com/sphireinc/Hydra"
    _ "github.com/go-sql-driver/mysql"
)

type Person struct {
    Name        string `json:"name" hydra:"name"`
    Age         int    `json:"age" hydra:"age"`
    Email       string `json:"email" hydra:"email"`
    hydra.Hydratable
}

func createDBConnection() *sql.DB {
    db, _ := sql.Open("mysql", "user:password@/dbname")
    return db
}

func main() {
    // Create a database connection
    db := createDBConnection() 

    // Create an addressable Person instance and initialize the hydra.Hydratable struct
    p := &Person{} 
    p.Init(p)

    // Create a map of where clauses
    whereClause := map[string]interface{}{"id": "U6"} 

    // Call Hydrate to populate the struct with data from the database
    p.Hydrate(db, whereClause)

    // Print the hydrated struct
    fmt.Printf("Hydrated person: %+v\n", p)
}

API Definition

TAGhydra

A struct tag used to map fields to database columns for hydration, formatted as `hydra:"column_name"`.

STRUCTHydratable

A struct that implements the IHydratable interface, used for hydrating objects with database data.

FUNCTIONInit(interface{}) interface{}

Initialize and hydrate a struct with metadata and database data. Ensures the provided object is a struct, processes its fields with 'hydra' tags, and sets up the object for further operations.

FUNCTIONHydrate(db any, whereClauses map[string]interface{}) error

Hydrate a struct by populating its fields with data fetched from the database. Uses 'hydra' tags to map database fields to struct fields.