Change ORM name to styx, also Database to Engine

Signed-off-by: Masudur Rahman <masudjuly02@gmail.com>

README.md

@@ -1,9 +1,9 @@
-# database
+# Styx
 Database Engine for different SQL and NoSQL databases
 
 ## Install
 ```shell
-go get -u github.com/masudur-rahman/database
+go get -u github.com/masudur-rahman/styx
 ```
 
 ## Quickstart
@@ -15,9 +15,9 @@ import (
 	"context"
 	"time"
 
-	"github.com/masudur-rahman/database/sql"
-	"github.com/masudur-rahman/database/sql/sqlite"
-	"github.com/masudur-rahman/database/sql/sqlite/lib"
+	"github.com/masudur-rahman/styx/sql"
+	"github.com/masudur-rahman/styx/sql/sqlite"
+	"github.com/masudur-rahman/styx/sql/sqlite/lib"
 )
 
 type User struct {
@@ -33,8 +33,8 @@ func main() {
 	conn, _ := lib.GetSQLiteConnection("test.db")
 
 	// Start a database engine
-	var db sql.Database
-	db = sqlite.NewSqlite(context.Background(), conn)
+	var db sql.Engine
+	db = sqlite.NewSQLite(context.Background(), conn)
 
 	// Migrate database
 	db.Sync(User{})
@@ -59,4 +59,21 @@ func main() {
 	db.ID(1).DeleteOne()              // delete by id
 	db.DeleteOne(User{Name: "masud"}) // delete using filter
 }
+
 ```
+
+<br>
+<hr>
+
+### Why `styx` name is chosen as this go orm
+
+* **Mythological Connection:** In Greek mythology, the River Styx separates the world of the living from the world of the dead.
+Similarly, this ORM acts as a bridge  between your application code (the living) and the database (the "dead" storage).
+It facilitates the flow of data between these two realms.
+
+* **Focus on Data Access:**  The Styx was also considered a barrier or boundary.  Similarly, this ORM acts as a controlled point of access for your application to interact with the database.
+It ensures data integrity and prevents unauthorized modification.
+
+* **Symbolism:** The Styx is often depicted as a dark and mysterious river. This can be seen as a metaphor for the complexity of database interactions that this ORM simplifies for developers.
+
+Overall, Styx evokes a sense of connection, control, and hidden power, all of which are relevant functionalities of an ORM.

dberr/check.go

@@ -1,6 +1,6 @@
 package dberr
 
-import "github.com/masudur-rahman/database/sql/postgres/lib"
+import "github.com/masudur-rahman/styx/sql/postgres/lib"
 
 func CheckEntityNameNonEmpty(entity string) error {
 	if entity == "" {

examples/quickstart.go

@@ -4,9 +4,9 @@ import (
 	"context"
 	"time"
 
-	"github.com/masudur-rahman/database/sql"
-	"github.com/masudur-rahman/database/sql/sqlite"
-	"github.com/masudur-rahman/database/sql/sqlite/lib"
+	"github.com/masudur-rahman/styx/sql"
+	"github.com/masudur-rahman/styx/sql/sqlite"
+	"github.com/masudur-rahman/styx/sql/sqlite/lib"
 )
 
 type User struct {
@@ -22,8 +22,8 @@ func main() {
 	conn, _ := lib.GetSQLiteConnection("test.db")
 
 	// Start a database engine
-	var db sql.Database
-	db = sqlite.NewSqlite(context.Background(), conn)
+	var db sql.Engine
+	db = sqlite.NewSQLite(context.Background(), conn)
 
 	// Migrate database
 	db.Sync(User{})

go.mod

@@ -1,4 +1,4 @@
-module github.com/masudur-rahman/database
+module github.com/masudur-rahman/styx
 
 go 1.20
 

mock/database.go

@@ -1,9 +1,9 @@
 package mock
 
-type Database interface {
-	Entity(name string) Database
+type Engine interface {
+	Entity(name string) Engine
 
-	ID(id string) Database
+	ID(id string) Engine
 
 	FindOne(document interface{}, filter ...interface{}) (bool, error)
 	FindMany(documents interface{}, filter interface{}) error

mock/map/map.go

@@ -3,8 +3,8 @@ package _map
 import (
 	"reflect"
 
-	"github.com/masudur-rahman/database/dberr"
-	"github.com/masudur-rahman/database/mock"
+	"github.com/masudur-rahman/styx/dberr"
+	"github.com/masudur-rahman/styx/mock"
 
 	"github.com/rs/xid"
 )
@@ -21,12 +21,12 @@ func NewMockDB() *MockDB {
 	}
 }
 
-func (m *MockDB) Entity(name string) mock.Database {
+func (m *MockDB) Entity(name string) mock.Engine {
 	m.entity = name
 	return m
 }
 
-func (m *MockDB) ID(id string) mock.Database {
+func (m *MockDB) ID(id string) mock.Engine {
 	m.id = id
 	return m
 }

nosql/arangodb/arangodb.go

@@ -3,9 +3,9 @@ package arangodb
 import (
 	"context"
 
-	"github.com/masudur-rahman/database/dberr"
-	"github.com/masudur-rahman/database/nosql"
-	"github.com/masudur-rahman/database/pkg"
+	"github.com/masudur-rahman/styx/dberr"
+	"github.com/masudur-rahman/styx/nosql"
+	"github.com/masudur-rahman/styx/pkg"
 
 	arango "github.com/arangodb/go-driver"
 )
@@ -24,12 +24,12 @@ func NewArangoDB(ctx context.Context, db arango.Database) ArangoDB {
 	}
 }
 
-func (a ArangoDB) Collection(collection string) nosql.Database {
+func (a ArangoDB) Collection(collection string) nosql.Engine {
 	a.collectionName = collection
 	return a
 }
 
-func (a ArangoDB) ID(id string) nosql.Database {
+func (a ArangoDB) ID(id string) nosql.Engine {
 	a.id = id
 	return a
 }

nosql/database.go

@@ -1,9 +1,9 @@
 package nosql
 
-type Database interface {
-	Collection(name string) Database
+type Engine interface {
+	Collection(name string) Engine
 
-	ID(id string) Database
+	ID(id string) Engine
 
 	FindOne(document interface{}, filter ...interface{}) (bool, error)
 	FindMany(documents interface{}, filter interface{}) error

sql/database.go

@@ -4,20 +4,20 @@ import (
 	"database/sql"
 )
 
-type Database interface {
-	BeginTx() (Database, error)
+type Engine interface {
+	BeginTx() (Engine, error)
 	Commit() error
 	Rollback() error
 
-	Table(name string) Database
+	Table(name string) Engine
 
-	ID(id any) Database
-	In(col string, values ...any) Database
-	Where(cond string, args ...any) Database
-	Columns(cols ...string) Database
-	AllCols() Database
-	MustCols(cols ...string) Database
-	ShowSQL(showSQL bool) Database
+	ID(id any) Engine
+	In(col string, values ...any) Engine
+	Where(cond string, args ...any) Engine
+	Columns(cols ...string) Engine
+	AllCols() Engine
+	MustCols(cols ...string) Engine
+	ShowSQL(showSQL bool) Engine
 
 	FindOne(document any, filter ...any) (bool, error)
 	FindMany(documents any, filter ...any) error

sql/postgres/lib/pg.go

@@ -9,8 +9,8 @@ import (
 	"strings"
 	"time"
 
-	"github.com/masudur-rahman/database/pkg"
-	"github.com/masudur-rahman/database/sql/postgres/pg-grpc/pb"
+	"github.com/masudur-rahman/styx/pkg"
+	"github.com/masudur-rahman/styx/sql/postgres/pg-grpc/pb"
 
 	"github.com/iancoleman/strcase"
 	_ "github.com/lib/pq"

sql/postgres/pg-grpc/postgres.go

@@ -5,10 +5,10 @@ import (
 	"database/sql"
 	"strings"
 
-	"github.com/masudur-rahman/database/dberr"
-	"github.com/masudur-rahman/database/pkg"
-	isql "github.com/masudur-rahman/database/sql"
-	"github.com/masudur-rahman/database/sql/postgres/pg-grpc/pb"
+	"github.com/masudur-rahman/styx/dberr"
+	"github.com/masudur-rahman/styx/pkg"
+	isql "github.com/masudur-rahman/styx/sql"
+	"github.com/masudur-rahman/styx/sql/postgres/pg-grpc/pb"
 
 	"google.golang.org/protobuf/types/known/anypb"
 )
@@ -27,32 +27,32 @@ func NewDatabase(ctx context.Context, client pb.PostgresClient) Database {
 	}
 }
 
-func (d Database) Table(name string) isql.Database {
+func (d Database) Table(name string) isql.Engine {
 	d.table = name
 	return d
 }
 
-func (d Database) ID(id any) isql.Database {
+func (d Database) ID(id any) isql.Engine {
 	d.id = id
 	return d
 }
 
-func (d Database) In(s string, a ...any) isql.Database {
+func (d Database) In(s string, a ...any) isql.Engine {
 	//TODO implement me
 	panic("implement me")
 }
 
-func (d Database) Where(s string, a ...any) isql.Database {
+func (d Database) Where(s string, a ...any) isql.Engine {
 	//TODO implement me
 	panic("implement me")
 }
 
-func (d Database) Columns(s ...string) isql.Database {
+func (d Database) Columns(s ...string) isql.Engine {
 	//TODO implement me
 	panic("implement me")
 }
 
-func (d Database) AllCols() isql.Database {
+func (d Database) AllCols() isql.Engine {
 	//TODO implement me
 	panic("implement me")
 }

sql/postgres/pg-grpc/postgres_helpers.go

@@ -1,7 +1,7 @@
 package pg_grpc
 
 import (
-	"github.com/masudur-rahman/database/sql/postgres/pg-grpc/pb"
+	"github.com/masudur-rahman/styx/sql/postgres/pg-grpc/pb"
 )
 
 func InitializePostgresClient() (pb.PostgresClient, error) {

sql/postgres/pg-grpc/server/postgres.go

@@ -7,9 +7,9 @@ import (
 	"log"
 	"net"
 
-	"github.com/masudur-rahman/database/pkg"
-	"github.com/masudur-rahman/database/sql/postgres/lib"
-	"github.com/masudur-rahman/database/sql/postgres/pg-grpc/pb"
+	"github.com/masudur-rahman/styx/pkg"
+	"github.com/masudur-rahman/styx/sql/postgres/lib"
+	"github.com/masudur-rahman/styx/sql/postgres/pg-grpc/pb"
 
 	"google.golang.org/grpc"
 	health "google.golang.org/grpc/health/grpc_health_v1"