Skip to content

feat: [#374] The postgres driver supports set schema #772

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
devhaozi merged 5 commits into from
Dec 19, 2024
Merged

feat: [#374] The postgres driver supports set schema #772

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d09e194
feat: [#374] The postgres driver supports set schema
hwbrzzl Dec 18, 2024
ee8c73a
fix test
hwbrzzl Dec 18, 2024
bf91f1f
remove comment
hwbrzzl Dec 18, 2024
55f892c
add test cases
hwbrzzl Dec 18, 2024
9e1f4c4
Merge branch 'master' into bowen/#374
h2zi Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions contracts/database/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ type Config struct {
Database string
Username string
Password string
// Only for Postgres
Schema string
}

// FullConfig Fill the default value for Config
Expand Down
3 changes: 3 additions & 0 deletions database/db/config_builder.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,9 @@ func (c *ConfigBuilder) fillDefault(configs []database.Config) []database.FullCo
if driver == database.DriverMysql || driver == database.DriverSqlserver {
fullConfig.Charset = c.config.GetString(fmt.Sprintf("database.connections.%s.charset", c.connection))
}
if fullConfig.Schema == "" && driver == database.DriverPostgres {
fullConfig.Schema = c.config.GetString(fmt.Sprintf("database.connections.%s.schema", c.connection), "public")
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
if driver == database.DriverMysql {
fullConfig.Loc = c.config.GetString(fmt.Sprintf("database.connections.%s.loc", c.connection))
}
Expand Down
4 changes: 2 additions & 2 deletions database/db/dsn.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ func Dsn(config database.FullConfig) string {
return fmt.Sprintf("%s:%s@tcp(%s:%d)/%s?charset=%s&parseTime=%t&loc=%s&multiStatements=true",
config.Username, config.Password, config.Host, config.Port, config.Database, config.Charset, true, config.Loc)
case database.DriverPostgres:
return fmt.Sprintf("postgres://%s:%s@%s:%d/%s?sslmode=%s&timezone=%s",
config.Username, config.Password, config.Host, config.Port, config.Database, config.Sslmode, config.Timezone)
return fmt.Sprintf("postgres://%s:%s@%s:%d/%s?sslmode=%s&timezone=%s&search_path=%s",
config.Username, config.Password, config.Host, config.Port, config.Database, config.Sslmode, config.Timezone, config.Schema)
case database.DriverSqlite:
return fmt.Sprintf("%s?multi_stmts=true", config.Database)
case database.DriverSqlserver:
Expand Down
6 changes: 4 additions & 2 deletions database/db/dsn_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ const (
testDatabase = "forge"
testUsername = "root"
testPassword = "123123"
testSchema = "public"
)

var testConfig = database.Config{
Expand All @@ -23,6 +24,7 @@ var testConfig = database.Config{
Database: testDatabase,
Username: testUsername,
Password: testPassword,
Schema: testSchema,
}

func TestDsn(t *testing.T) {
Expand Down Expand Up @@ -65,8 +67,8 @@ func TestDsn(t *testing.T) {
Sslmode: "disable",
Timezone: "UTC",
},
expectDsn: fmt.Sprintf("postgres://%s:%s@%s:%d/%s?sslmode=%s&timezone=%s",
testUsername, testPassword, testHost, testPort, testDatabase, "disable", "UTC"),
expectDsn: fmt.Sprintf("postgres://%s:%s@%s:%d/%s?sslmode=%s&timezone=%s&search_path=%s",
testUsername, testPassword, testHost, testPort, testDatabase, "disable", "UTC", testSchema),
},
{
name: "sqlite",
Expand Down
20 changes: 20 additions & 0 deletions database/gorm/query_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3831,6 +3831,26 @@ func TestTablePrefixAndSingular(t *testing.T) {
}
}

func TestSchema(t *testing.T) {
if env.IsWindows() {
t.Skip("Skip test that using Docker")
}

postgresDocker := supportdocker.Postgres()
require.NoError(t, postgresDocker.Ready())

Comment thread
coderabbitai[bot] marked this conversation as resolved.
testQuery := NewTestQueryWithSchema(postgresDocker, "goravel")
testQuery.CreateTable(TestTableUsers)

user := User{Name: "first_user"}
assert.Nil(t, testQuery.Query().Create(&user))
assert.True(t, user.ID > 0)

var user1 User
assert.Nil(t, testQuery.Query().Where("name", "first_user").First(&user1))
assert.True(t, user1.ID > 0)
}

func paginator(page string, limit string) func(methods contractsorm.Query) contractsorm.Query {
return func(query contractsorm.Query) contractsorm.Query {
page, _ := strconv.Atoi(page)
Expand Down
110 changes: 89 additions & 21 deletions database/gorm/test_utils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ type testMockDriver interface {
Common()
ReadWrite(readDatabaseConfig testing.DatabaseConfig)
WithPrefixAndSingular()
WithSchema(schema string)
}

type TestQueries struct {
Expand Down Expand Up @@ -145,7 +146,13 @@ func (r *TestQueries) queries(withPrefixAndSingular bool) map[contractsdatabase.
}

for driver, docker := range driverToDocker {
query := NewTestQuery(docker, withPrefixAndSingular)
var query *TestQuery
if withPrefixAndSingular {
query = NewTestQueryWithPrefixAndSingular(docker)
} else {
query = NewTestQuery(docker)
}

driverToTestQuery[driver] = query
}

Expand All @@ -159,28 +166,75 @@ type TestQuery struct {
query orm.Query
}

func NewTestQuery(docker testing.DatabaseDriver, withPrefixAndSingular ...bool) *TestQuery {
func NewTestQuery(docker testing.DatabaseDriver) *TestQuery {
mockConfig := &mocksconfig.Config{}
mockDriver := getMockDriver(docker, mockConfig, docker.Driver().String())
testQuery := &TestQuery{
docker: docker,
mockConfig: mockConfig,
mockDriver: mockDriver,
}

mockDriver.Common()
query, err := BuildQuery(testContext, mockConfig, docker.Driver().String(), nil, nil)
if err != nil {
panic(fmt.Sprintf("connect to %s failed: %v", docker.Driver().String(), err))
}

testQuery.query = query

return testQuery
}

func NewTestQueryWithPrefixAndSingular(docker testing.DatabaseDriver) *TestQuery {
mockConfig := &mocksconfig.Config{}
mockDriver := getMockDriver(docker, mockConfig, docker.Driver().String())
testQuery := &TestQuery{
docker: docker,
mockConfig: mockConfig,
mockDriver: mockDriver,
}

var (
query *Query
err error
)
if len(withPrefixAndSingular) > 0 && withPrefixAndSingular[0] {
mockDriver.WithPrefixAndSingular()
query, err = BuildQuery(testContext, mockConfig, docker.Driver().String(), nil, nil)
} else {
mockDriver.Common()
query, err = BuildQuery(testContext, mockConfig, docker.Driver().String(), nil, nil)
mockDriver.WithPrefixAndSingular()
query, err := BuildQuery(testContext, mockConfig, docker.Driver().String(), nil, nil)
if err != nil {
panic(fmt.Sprintf("connect to %s failed: %v", docker.Driver().String(), err))
}

testQuery.query = query

return testQuery
}

func NewTestQueryWithSchema(docker testing.DatabaseDriver, schema string) *TestQuery {
if docker.Driver() != contractsdatabase.DriverPostgres && docker.Driver() != contractsdatabase.DriverSqlserver {
panic(fmt.Sprintf("%s does not support schema", docker.Driver().String()))
}

// Create schema before build query with the schema
mockConfig := &mocksconfig.Config{}
mockDriver := getMockDriver(docker, mockConfig, docker.Driver().String())
mockDriver.WithPrefixAndSingular()
query, err := BuildQuery(testContext, mockConfig, docker.Driver().String(), nil, nil)
if err != nil {
panic(fmt.Sprintf("connect to %s failed: %v", docker.Driver().String(), err))
}

if _, err := query.Exec(fmt.Sprintf("CREATE SCHEMA %s", schema)); err != nil {
panic(fmt.Sprintf("create schema %s failed: %v", schema, err))
}

mockConfig = &mocksconfig.Config{}
mockDriver = getMockDriver(docker, mockConfig, docker.Driver().String())
testQuery := &TestQuery{
docker: docker,
mockConfig: mockConfig,
mockDriver: mockDriver,
}

mockDriver.WithSchema(schema)

query, err = BuildQuery(testContext, mockConfig, docker.Driver().String(), nil, nil)
Comment thread
hwbrzzl marked this conversation as resolved.
if err != nil {
panic(fmt.Sprintf("connect to %s failed: %v", docker.Driver().String(), err))
}
Expand Down Expand Up @@ -261,8 +315,6 @@ func NewMockMysql(mockConfig *mocksconfig.Config, connection, database, username
}

func (r *MockMysql) Common() {
r.mockConfig.On("GetString", "database.default").Return("mysql")
r.mockConfig.On("GetString", "database.migrations.table").Return("migrations")
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.prefix", r.connection)).Return("")
r.mockConfig.On("GetBool", fmt.Sprintf("database.connections.%s.singular", r.connection)).Return(false)
r.single()
Expand All @@ -289,6 +341,10 @@ func (r *MockMysql) WithPrefixAndSingular() {
r.basic()
}

func (r *MockMysql) WithSchema(schema string) {
panic("mysql does not support schema")
}

func (r *MockMysql) basic() {
r.mockConfig.On("GetBool", "app.debug").Return(true)
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.driver", r.connection)).Return(r.driver.String())
Expand Down Expand Up @@ -334,10 +390,9 @@ func NewMockPostgres(mockConfig *mocksconfig.Config, connection, database, usern
}

func (r *MockPostgres) Common() {
r.mockConfig.On("GetString", "database.default").Return("postgres")
r.mockConfig.On("GetString", "database.migrations.table").Return("migrations")
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.prefix", r.connection)).Return("")
r.mockConfig.On("GetBool", fmt.Sprintf("database.connections.%s.singular", r.connection)).Return(false)
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.schema", r.connection), "public").Return("public")
r.single()
r.basic()
}
Expand All @@ -352,12 +407,22 @@ func (r *MockPostgres) ReadWrite(readDatabaseConfig testing.DatabaseConfig) {
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.dsn", r.connection)).Return("")
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.prefix", r.connection)).Return("")
r.mockConfig.On("GetBool", fmt.Sprintf("database.connections.%s.singular", r.connection)).Return(false)
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.schema", r.connection), "public").Return("public")
r.basic()
}

func (r *MockPostgres) WithPrefixAndSingular() {
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.prefix", r.connection)).Return("goravel_")
r.mockConfig.On("GetBool", fmt.Sprintf("database.connections.%s.singular", r.connection)).Return(true)
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.schema", r.connection), "public").Return("public")
r.single()
r.basic()
}

func (r *MockPostgres) WithSchema(schema string) {
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.prefix", r.connection)).Return("")
r.mockConfig.On("GetBool", fmt.Sprintf("database.connections.%s.singular", r.connection)).Return(false)
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.schema", r.connection), "public").Return(schema)
r.single()
r.basic()
}
Expand All @@ -368,7 +433,6 @@ func (r *MockPostgres) basic() {
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.sslmode", r.connection)).Return("disable")
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.timezone", r.connection)).Return("UTC")
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.database", r.connection)).Return(r.database)
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.search_path", r.connection), "public").Return("public")

mockPool(r.mockConfig)
}
Expand Down Expand Up @@ -401,8 +465,6 @@ func NewMockSqlite(mockConfig *mocksconfig.Config, connection, database string)
}

func (r *MockSqlite) Common() {
r.mockConfig.On("GetString", "database.default").Return("sqlite")
r.mockConfig.On("GetString", "database.migrations.table").Return("migrations")
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.prefix", r.connection)).Return("")
r.mockConfig.On("GetBool", fmt.Sprintf("database.connections.%s.singular", r.connection)).Return(false)
r.single()
Expand All @@ -428,6 +490,10 @@ func (r *MockSqlite) WithPrefixAndSingular() {
r.basic()
}

func (r *MockSqlite) WithSchema(schema string) {
panic("sqlite does not support schema")
}

func (r *MockSqlite) basic() {
r.mockConfig.On("GetBool", "app.debug").Return(true)
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.driver", r.connection)).Return(r.driver.String())
Expand Down Expand Up @@ -464,8 +530,6 @@ func NewMockSqlserver(mockConfig *mocksconfig.Config, connection, database, user
}

func (r *MockSqlserver) Common() {
r.mockConfig.On("GetString", "database.default").Return("sqlserver")
r.mockConfig.On("GetString", "database.migrations.table").Return("migrations")
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.prefix", r.connection)).Return("")
r.mockConfig.On("GetBool", fmt.Sprintf("database.connections.%s.singular", r.connection)).Return(false)
r.single()
Expand All @@ -492,6 +556,10 @@ func (r *MockSqlserver) WithPrefixAndSingular() {
r.basic()
}

func (r *MockSqlserver) WithSchema(schema string) {
panic("sqlserver does not support schema for now")
}

func (r *MockSqlserver) basic() {
r.mockConfig.On("GetBool", "app.debug").Return(true)
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.driver", r.connection)).Return(r.driver.String())
Expand Down
Loading