Godex

A Go utility for creating and managing reusable SQL queries, streamlining database interactions in Go applications.

Overview

Godex is a Go utility designed to simplify database interactions by allowing developers to define and manage reusable SQL queries. By organizing queries into a structured format, Godex enhances code readability and maintainability, reducing redundancy and potential errors in database operations. It supports common CRUD operations and custom queries, facilitating efficient data management.


package main

import (
    "fmt"
    "github.com/sphireinc/Godex"
)

func main() {
    // Initialize a new Codex for the 'posts' table
    q := godex.Codex{
        Table: "posts",
        DefaultQueries: godex.DefaultQueries{
            SelectById: "SELECT * FROM posts WHERE id = :id",
            Insert:     "INSERT INTO posts(post_id) VALUES (:post_id)",
            Update:     "UPDATE posts SET is_active=:is_active WHERE id=:id",
            Delete:     "DELETE FROM posts WHERE id=:id",
        },
        Queries: map[string]string{
            "SelectUsersByFirstName": "SELECT * FROM users WHERE first_name = :first_name",
        },
    }

    // Execute a default query
    res, err := q.SelectById(godex.CxArgs{"id": 154})
    if err != nil {
        panic(err)
    }
    fmt.Println("Post ID:", res["post_id"])

    // Execute a custom query
    users, err := q.RawQuery(q.Queries["SelectUsersByFirstName"], godex.CxArgs{"first_name": "John"})
    if err != nil {
        panic(err)
    }
    fmt.Println("Users:", users)
}

API Definition

STRUCTCodex

Represents a collection of reusable SQL queries associated with a specific database table.

STRUCTDefaultQueries

Holds default CRUD SQL queries for a given table, facilitating standard database operations.

FUNCTIONSelectById(args CxArgs) (map[string]interface{}, error)

Executes the 'SelectById' query to retrieve a record by its ID.

FUNCTIONRawQuery(query string, args CxArgs) ([]map[string]interface{}, error)

Executes a custom SQL query with the provided arguments, returning the result set.