# README
GoLang query builder
Simple query builder, for SQL-like databases.
Databases supported
- MySQL
- SQLite
How to use?
Import the ORM package
import (
"github.com/sharovik/orm/clients"
cdto "github.com/sharovik/orm/dto" //If you don't have the `dto` package name in your project, then you can remove custom `cdto` alias
)
Init the client
//For sqlite
databaseClient, err := clients.InitClient(clients.DatabaseConfig{
Host: "mysqlite-database.sqlite",
})
//For mysql
databaseClient, err := clients.InitClient(clients.DatabaseConfig{
Host: "localhost",
Username: "root",
Password: "secret",
Database: "test",
Type: clients.DatabaseTypeMySQL,
})
Start using the query builder
There are several ways, how you can communicate with database using this query builder
Using model
package main
import "github.com/sharovik/orm/dto"
type TestTableModel struct {
dto.BaseModel
}
func main() {
model := new(TestTableModel)
model.SetTableName("test_table_name")
model.SetPrimaryKey(dto.ModelField{
Name: "id",
Type: "integer",
Value: nil,
Default: nil,
Length: 0,
IsNullable: false,
IsUnsigned: true,
AutoIncrement: true,
})
model.AddModelField(dto.ModelField{
Name: "another_id",
Type: dto.IntegerColumnType,
Value: nil,
Default: nil,
Length: 0,
IsNullable: true,
IsPrimaryKey: false,
IsUnsigned: true,
AutoIncrement: false,
})
//Get results sqlite
results, err := databaseClient.Execute(new(Query).Select([]interface{}{"col1", "col2"}).From(&model))
//do something with the results...
}
This code will execute the next SQL query
SELECT col1, col2 FROM test_table_name
Without model
If you don't want to use model for your query, you can pass the table name string as argument for From method.
results, err := databaseClient.Execute(new(Query).Select([]interface{}{"col1", "col2"}).From("test_table_name"))
Complex queries
You can also build more complex queries, like:
SELECT id, another_id FROM test_table_name
LEFT JOIN another ON another.id = test_table_name.another_id
WHERE another.id is NULL
This how it will look in code:
var columns = []interface{}{"id", "another_id"}
q = new(clients.Query).
Select(columns).
From(&model).
Join(query.Join{
Target: query.Reference{Table: "another", Key: "id"},
With: query.Reference{Table: model.TableName, Key: "another_id"},
Condition: "=",
Type: query.LeftJoinType,
}).
Where(query.Where{
First: "another.id",
Operator: "is",
Second: "NULL",
})
result, err := client.Execute(q)
OR even queries with the complex WHERE CLAUSE, like this:
SELECT id, another_id, test_field, test_field2 FROM test_table_name WHERE (id = 1 OR id = 2) OR id = 3
In code this will look like:
q = new(clients.Query).Select(&model.GetColumns()).
From(&model).
Where(query.Where{
First: query.Where{
First: "id",
Operator: "=",
Second: "1",
},
Operator: "",
Second: query.Where{
First: "id",
Operator: "=",
Second: "2",
Type: query.WhereOrType, //For OR condition, you can use the Type attribute of Where object
},
}).
Where(query.Where{
First: "id",
Operator: "=",
Second: "3",
Type: query.WhereOrType, //For OR condition, you can use the Type attribute of Where object
})
res, err = client.Execute(q)
And for sure you always can use the query binding for the untrusted data
q = new(clients.Query).
Select(model.GetColumns()).
From(&model).
Where(query.Where{
First: "name",
Operator: "=",
Second: query.Bind{
Field: "name",
Value: "my test name",
},
})
result, err := client.Execute(q)
This will generate the next prepared query
SELECT id, name FROM test_table_name WHERE name = ?
Please see the examples.go file for more queries examples. And also, please check the documentation files here.