fix(client): add the ability to switch to other schemas (#267)

* feat(oracle): add the ability to switch to other schemas

* feat(client): fix the queries to query against ALL* tables

* fix(client): fix set search_path query for postgres

* feat(client): add a way to handle the schema in the client side for the oracle databases

* feat(oracle): add a way to build queries based on if the schema flag is present or not

* docs(config): fix a typo in the example config file

* docs(readme): update the readme file to include the use of the schema for the oracle databases

* refactor(client): refactor the oracle client to remove the else statements

* docs(docs): update the documents in the docs directory

Author: danvergara

.dblab.yaml

@@ -19,7 +19,7 @@ database:
   - name: "oracle"
     host: "localhost"
     port: 1521
-    db: "FREEPDB1 "
+    db: "FREEPDB1"
     password: "password"
     user: "system"
     driver: "oracle"

README.md

@@ -104,7 +104,7 @@ Flags:
       --limit uint                        Size of the result set from the table content query (should be greater than zero, otherwise the app will error out) (default 100)
       --pass string                       Password for user
       --port string                       Server port
-      --schema string                     Database schema (postgres only)
+      --schema string                     Database schema (postgres and oracle only)
       --socket string                     Path to a Unix socket file
       --ssh-host string                   SSH Server Hostname/IP
       --ssh-key string                    File with private key for SSH authentication
@@ -152,11 +152,16 @@ $ dblab --url 'oracle://user:password@localhost:1521/db'
 $ dblab --url 'sqlserver://SA:myStrong(!)Password@localhost:1433?database=tempdb&encrypt=true&trustservercertificate=false&connection+timeout=30'
 ```
 
-if you're using PostgreSQL, you have the option to define the schema you want to work with, the default value is `public`.
+if you're using PostgreSQL or Oracle, you have the option to define the schema you want to work with, the default value is `public` for Postgres, empty for Oracle.
 
 ```sh
+# Postgres
 $ dblab --host localhost --user myuser --db users --pass password --schema myschema --ssl disable --port 5432 --driver postgres --limit 50
 $ dblab --url postgres://user:password@host:port/database?sslmode=[mode] --schema myschema
+
+# Oracle
+$ dblab --host localhost --user user2 --db FREEPDB1 --pass password --port 1521 --driver oracle --limit 50 --schema user1
+$ dblab --url 'oracle://user2:password@localhost:1521/FREEPDB1' --schema user1
 ```
 
 As a request made in [#125](https://github.com/danvergara/dblab/issues/125), support for MySQL/MariaDB sockets was integrated.
@@ -288,9 +293,10 @@ database:
   - name: "oracle"
     host: "localhost"
     port: 1521
-    db: "FREEPDB1 "
+    db: "FREEPDB1"
+    schema: "user1"
     password: "password"
-    user: "system"
+    user: "user2"
     driver: "oracle"
     ssl: "enable"
     wallet: "path/to/wallet"

cmd/root.go

@@ -188,7 +188,8 @@ func init() {
 	rootCmd.Flags().StringVarP(&user, "user", "", "", "Database user")
 	rootCmd.Flags().StringVarP(&pass, "pass", "", "", "Password for user")
 	rootCmd.Flags().StringVarP(&db, "db", "", "", "Database name (optional)")
-	rootCmd.Flags().StringVarP(&schema, "schema", "", "", "Database schema (postgres only)")
+	rootCmd.Flags().
+		StringVarP(&schema, "schema", "", "", "Database schema (postgres and oracle only)")
 	rootCmd.Flags().StringVarP(&ssl, "ssl", "", "", "SSL mode")
 	rootCmd.Flags().
 		UintVarP(&limit, "limit", "", 100, "Size of the result set from the table content query (should be greater than zero, otherwise the app will error out)")

docs/quickstart.md

@@ -26,14 +26,20 @@ dblab --url mysql://user:password@tcp(host:port)/db
 dblab --url file:test.db?cache=shared&mode=memory
 ```
 
-if you're using PostgreSQL, you have the option to define the schema you want to work with, the default value is `public`.
+if you're using PostgreSQL or Oracle, you have the option to define the schema you want to work with, the default value is `public` for Postgres, empty for Oracle.
 
 ```{ .sh .copy }
 dblab --host localhost --user myuser --db users --pass password --schema myschema --ssl disable --port 5432 --driver postgres --limit 50
 ```
 ```{ .sh .copy }
 dblab --url postgres://user:password@host:port/database?sslmode=[mode] --schema myschema
 ```
+```{ .sh .copy }
+dblab --host localhost --user user2 --db FREEPDB1 --pass password --port 1521 --driver oracle --limit 50 --schema user1
+```
+```{ .sh .copy }
+dblab --url 'oracle://user2:password@localhost:1521/FREEPDB1' --schema user1
+```
 
 As a request made in [#125](https://github.com/danvergara/dblab/issues/125), support for MySQL/MariaDB sockets was integrated.
 
@@ -80,6 +86,17 @@ database:
     user: "postgres"
     schema: "public"
     driver: "postgres"
+  - name: "oracle"
+    host: "localhost"
+    port: 1521
+    db: "FREEPDB1"
+    schema: "user1"
+    password: "password"
+    user: "user2"
+    driver: "oracle"
+    ssl: "enable"
+    wallet: "path/to/wallet"
+    ssl-verify: true
 # should be greater than 0, otherwise the app will error out
 limit: 50
 ```

docs/usage.md

@@ -44,7 +44,7 @@ Flags:
       --limit uint                        Size of the result set from the table content query (should be greater than zero, otherwise the app will error out) (default 100)
       --pass string                       Password for user
       --port string                       Server port
-      --schema string                     Database schema (postgres only)
+      --schema string                     Database schema (postgres and oracle only)
       --socket string                     Path to a Unix socket file
       --ssh-host string                   SSH Server Hostname/IP
       --ssh-key string                    File with private key for SSH authentication
@@ -158,7 +158,9 @@ dblab --url 'oracle://user:password@localhost:1521/db'
 dblab --url 'sqlserver://SA:myStrong(!)Password@localhost:1433?database=tempdb&encrypt=true&trustservercertificate=false&connection+timeout=30'
 ```
 
-if you're using PostgreSQL, you have the option to define the schema you want to work with, the default value is `public`.
+if you're using PostgreSQL or Oracle, you have the option to define the schema you want to work with, the default value is `public` for Postgres, empty for Oracle.
+
+**Postgres**
 
 ```{ .sh .copy }
 dblab --host localhost --user myuser --db users --pass password --schema myschema --ssl disable --port 5432 --driver postgres --limit 50
@@ -167,6 +169,15 @@ dblab --host localhost --user myuser --db users --pass password --schema myschem
 dblab --url postgres://user:password@host:port/database?sslmode=[mode] --schema myschema
 ```
 
+**Oracle**
+
+```{ .sh .copy }
+dblab --host localhost --user user2 --db FREEPDB1 --pass password --port 1521 --driver oracle --limit 50 --schema user1
+```
+```{ .sh .copy }
+dblab --url 'oracle://user2:password@localhost:1521/FREEPDB1' --schema user1
+```
+
 As a request made in [#125](https://github.com/danvergara/dblab/issues/125), support for MySQL/MariaDB sockets was integrated.
 
 ```{ .sh .copy }
@@ -300,9 +311,10 @@ database:
   - name: "oracle"
     host: "localhost"
     port: 1521
-    db: "FREEPDB1 "
+    db: "FREEPDB1"
+    schema: "user1"
     password: "password"
-    user: "system"
+    user: "user2"
     driver: "oracle"
     ssl: "enable"
     wallet: "path/to/wallet"

pkg/client/client.go

@@ -64,7 +64,10 @@ func New(opts command.Options) (*Client, error) {
 	}
 
 	if opts.Schema == "" {
-		c.schema = "public"
+		switch c.driver {
+		case drivers.Postgres, drivers.PostgreSQL, drivers.PostgresSSH:
+			c.schema = "public"
+		}
 	} else {
 		c.schema = opts.Schema
 	}
@@ -78,7 +81,7 @@ func New(opts command.Options) (*Client, error) {
 	case drivers.SQLite:
 		c.databaseQuerier = newSQLite()
 	case drivers.Oracle:
-		c.databaseQuerier = newOracle()
+		c.databaseQuerier = newOracle(c.schema)
 	case drivers.SQLServer:
 		c.databaseQuerier = newMSSQL()
 	default:
@@ -107,9 +110,15 @@ func New(opts command.Options) (*Client, error) {
 
 	switch c.driver {
 	case drivers.PostgreSQL, drivers.Postgres, drivers.PostgresSSH:
-		if _, err = db.Exec(fmt.Sprintf("set search_path='%s'", c.schema)); err != nil {
+		if _, err = db.Exec(fmt.Sprintf("set search_path = '%s'", c.schema)); err != nil {
 			return nil, err
 		}
+	case drivers.Oracle:
+		if c.schema != "" {
+			if _, err = db.Exec(fmt.Sprintf("ALTER SESSION SET CURRENT_SCHEMA = %s", c.schema)); err != nil {
+				return nil, err
+			}
+		}
 	}
 
 	pm, err := pagination.New(c.limit, 0, "")

pkg/client/oracle.go

@@ -8,41 +8,68 @@ import (
 )
 
 // oracle struct is in charge of perform all the oracle related queries.
-type oracle struct{}
+type oracle struct {
+	schema string
+}
 
 // a validation to see if oracle is implementing databaseQuerier.
 var _ databaseQuerier = (*oracle)(nil)
 
 // returns a pointer to a oracle struct, it receives an schema as a parameter.
-func newOracle() *oracle {
-	o := oracle{}
+func newOracle(schema string) *oracle {
+	// If the schema is no empty, the client queries against the ALL_* tables,
+	// where the OWNER is equal to the schema/user the dblab user has access to.
+	// Otherwise, the client will query against the USER_* tables,
+	// meaning it only cares about what the user has direct access to.
+	o := oracle{schema: schema}
 
 	return &o
 }
 
-func (p *oracle) ShowTablesPerDB(dabase string) (string, []interface{}, error) {
+func (o *oracle) ShowTablesPerDB(dabase string) (string, []interface{}, error) {
 	return "", nil, nil
 }
 
-func (p *oracle) ShowDatabases() (string, []interface{}, error) {
+func (o *oracle) ShowDatabases() (string, []interface{}, error) {
 	return "", nil, nil
 }
 
 // ShowTables returns a query to retrieve all the tables.
-func (p *oracle) ShowTables() (string, []interface{}, error) {
-	query := "SELECT table_name FROM user_tables"
-	return query, nil, nil
+func (o *oracle) ShowTables() (string, []interface{}, error) {
+	var query sq.SelectBuilder
+
+	query = sq.Select("TABLE_NAME").
+		From("USER_TABLES")
+
+	if o.schema != "" {
+		query = sq.Select("TABLE_NAME").
+			From("ALL_TABLES").
+			Where(sq.Eq{"OWNER": strings.ToUpper(o.schema)})
+	}
+
+	sql, args, err := query.OrderBy("1").PlaceholderFormat(sq.Colon).ToSql()
+	if err != nil {
+		return "", nil, err
+	}
+
+	return sql, args, nil
 }
 
 // TableStructure returns a query string to get all the relevant information of a given table.
-func (p *oracle) TableStructure(tableName string) (string, []interface{}, error) {
-	query := sq.Select("*").
-		From("user_tab_columns").
-		Where(sq.Eq{"table_name": strings.ToUpper(tableName)}).
-		OrderBy("column_id").
-		PlaceholderFormat(sq.Colon)
-
-	sql, args, err := query.ToSql()
+func (o *oracle) TableStructure(tableName string) (string, []interface{}, error) {
+	var query sq.SelectBuilder
+
+	query = sq.Select("*").
+		From("USER_TAB_COLUMNS").
+		Where(sq.Eq{"TABLE_NAME": strings.ToUpper(tableName)})
+
+	if o.schema != "" {
+		query = sq.Select("*").
+			From("ALL_TAB_COLUMNS").
+			Where(sq.Eq{"TABLE_NAME": strings.ToUpper(tableName), "OWNER": strings.ToUpper(o.schema)})
+	}
+
+	sql, args, err := query.OrderBy("1").PlaceholderFormat(sq.Colon).ToSql()
 	if err != nil {
 		return "", nil, err
 	}
@@ -51,16 +78,26 @@ func (p *oracle) TableStructure(tableName string) (string, []interface{}, error)
 }
 
 // Constraints returns all the constraints of a given table.
-func (p *oracle) Constraints(tableName string) (string, []interface{}, error) {
-	query := sq.Select(
-		`constraint_name`,
-		`constraint_type`,
+func (o *oracle) Constraints(tableName string) (string, []interface{}, error) {
+	var query sq.SelectBuilder
+
+	query = sq.Select(
+		`CONSTRAINT_NAME`,
+		`CONSTRAINT_TYPE`,
 	).
-		From("user_constraints").
-		Where(sq.Eq{"table_name": tableName}).
-		PlaceholderFormat(sq.Colon)
+		From("USER_CONSTRAINTS").
+		Where(sq.Eq{"TABLE_NAME": strings.ToUpper(tableName)})
+
+	if o.schema != "" {
+		query = sq.Select(
+			`CONSTRAINT_NAME`,
+			`CONSTRAINT_TYPE`,
+		).
+			From("ALL_CONSTRAINTS").
+			Where(sq.Eq{"TABLE_NAME": strings.ToUpper(tableName), "OWNER": strings.ToUpper(o.schema)})
+	}
 
-	sql, args, err := query.ToSql()
+	sql, args, err := query.PlaceholderFormat(sq.Colon).ToSql()
 	if err != nil {
 		return "", nil, err
 	}
@@ -69,15 +106,23 @@ func (p *oracle) Constraints(tableName string) (string, []interface{}, error) {
 }
 
 // Indexes returns the indexes of a table.
-func (p *oracle) Indexes(tableName string) (string, []interface{}, error) {
-	sql, args, err := sq.Select("*").
-		From("all_indexes").
-		Where(sq.Eq{"table_name": tableName}).
-		PlaceholderFormat(sq.Colon).
-		ToSql()
+func (o *oracle) Indexes(tableName string) (string, []interface{}, error) {
+	var query sq.SelectBuilder
+
+	query = sq.Select("*").
+		From("USER_INDEXES").
+		Where(sq.Eq{"TABLE_NAME": strings.ToUpper(tableName)})
+
+	if o.schema != "" {
+		query = sq.Select("*").
+			From("ALL_INDEXES").
+			Where(sq.Eq{"TABLE_NAME": strings.ToUpper(tableName), "OWNER": strings.ToUpper(o.schema)})
+	}
+
+	sql, args, err := query.PlaceholderFormat(sq.Colon).ToSql()
 	if err != nil {
 		return "", nil, err
 	}
 
-	return sql, args, err
+	return sql, args, nil
 }