CrudifyGO

Effortlessly simplify Golang CRUD API development for multiple databases.

MySQL

Table of Contents

• Database Methods

  1. OpenDbConnect
  2. PingYourDb
  3. ListDatabases
  4. CreateDb
  5. DeleteDb
  6. CreateMultipleDb (In-Progress)
  7. DeleteMultipleDb (In-Progress)

• Tabular Methods

  1. ListTablesDb
  2. GetTableContent

Database Methods Implementation

1. OpenDbConnect : Establish Connection to a database from database connection pool

   • Parameters :
     • Name of Database (string)
   • Return Type :
     • *sql.DB (pointer to sql.DB object)
     • error

   Example

   db,err := OpenDbConnect("databasename")
   if err!=nil{
       c.JSON(http.StatusInternalServerError, gin.H{"Error":err.Error()})
       return
   }

2. PingYourDb : Check connection to a database

   • Parameters :
     • Name of Database (string)
   • Return Type :
     • connection status
     • error

   Example

   pingstatus,err := PingYourDb("databasename")
   if err!=nil{
       c.JSON(http.StatusInternalServerError, gin.H{"Error":err.Error()})
   }
   c.JSON(http.StatusCreated, gin.H{"Message":pingstatus})

3. ListDatabases : List all databases on MySQL RDBMS

   • Parameters :
     • Nil
   • Return Type :
     • array of present databases
     • error

   Example

   databases, err := mysql.ListDatabases()
   if err != nil {
       c.JSON(http.StatusInternalServerError, gin.H{"Error": err.Error()})
       return
   }
   
   c.IndentedJSON(http.StatusAccepted, gin.H{
       "Message":   "Received databases",
       "databases": databases,
   })

4. CreateDb : Create a database in MySQL

   • Parameters :
     • databasename (string)
   • Return Type :
     • error

   Example

   database_name := c.Query("databasename")
   
   err := mysql.CreateDb(database_name)
   if err != nil {
       c.JSON(http.StatusInternalServerError, gin.H{"Error": err.Error()})
       return
   }
   
   c.JSON(http.StatusCreated, gin.H{"Message": fmt.Sprintf("Created database %s successfully", database_name)})

5. DeleteDb : Delete a database in MySQL

   • Parameters :
     • databasename string
   • Return Type :
     • error

   Example

   database_name := c.Query("databasename")
   
   err := mysql.DeleteDb(database_name)
   if err != nil {
       c.JSON(http.StatusInternalServerError, gin.H{"Error": err.Error()})
       return
   }
   
   c.JSON(http.StatusCreated, gin.H{"Message": fmt.Sprintf("Deleted database %s successfully", database_name)})

Tabular Methods Implementation

1. ListTablesDb : List tables in a MySQL database

   • Parameters :
     • databasename (string)
   • Return Type :
     • table ([]string)
     • error

   Example

   database_name := c.Query("databasename")
   
   tables, err := mysql.ListTablesDb(database_name)
   if err != nil {
       c.JSON(http.StatusInternalServerError, gin.H{"Error": err.Error()})
       return
   }
   
   c.JSON(http.StatusCreated, gin.H{
       "Message":"Listed Tables Successfully",
       "Tables":tables,
   })

2. GetTableContent : Get all content from a table in DB

   • Parameters :
     • Name of Database (string)
     • Name of Table (string)
     • Empty structure object to store table data (struct obj)
   • Return Type :
     • error

   Example

PostgreSQL (In-Development)

SQLite (In-Development)