// oci8 implements a gorm dialect for oracle package oci8 import ( "database/sql" "fmt" "reflect" "strconv" "strings" "time" "github.com/jinzhu/gorm" _ "github.com/mattn/go-oci8" ) const dialectName = "oci8" var _ gorm.Dialect = (*oci8)(nil) type oci8 struct { db gorm.SQLCommon gorm.DefaultForeignKeyNamer } func init() { gorm.RegisterDialect(dialectName, &oci8{}) } func (s *oci8) fieldCanAutoIncrement(field *gorm.StructField) bool { if value, ok := field.TagSettingsGet("AUTO_INCREMENT"); ok { return strings.ToLower(value) != "false" } return field.IsPrimaryKey } func (oci8) GetName() string { return dialectName } func (oci8) BindVar(i int) string { return fmt.Sprintf(":%v", i) } func (oci8) Quote(key string) string { if isReserved(key) { return fmt.Sprintf(`"%s"`, key) } return key } func (s oci8) CurrentDatabase() string { var name string if err := s.db.QueryRow("SELECT ORA_DATABASE_NAME as \"Current Database\" FROM DUAL").Scan(&name); err != nil { return "" // just return "", since the Dialect interface doesn't support returning an error for this func } return name } func (oci8) DefaultValueStr() string { return "VALUES (DEFAULT)" } func (s oci8) HasColumn(tableName string, columnName string) bool { var count int _, tableName = currentDatabaseAndTable(&s, tableName) tableName = strings.ToUpper(tableName) columnName = strings.ToUpper(columnName) if err := s.db.QueryRow("SELECT count(*) FROM ALL_TAB_COLUMNS WHERE TABLE_NAME = :1 AND COLUMN_NAME = :2", tableName, columnName).Scan(&count); err == nil { return count > 0 } return false } func (s oci8) HasForeignKey(tableName string, foreignKeyName string) bool { var count int tableName = strings.ToUpper(tableName) foreignKeyName = strings.ToUpper(foreignKeyName) if err := s.db.QueryRow(`SELECT count(*) FROM USER_CONSTRAINTS WHERE CONSTRAINT_NAME = :1 AND constraint_type = 'R' AND table_name = :2`, foreignKeyName, tableName).Scan(&count); err == nil { return count > 0 } return false } func (s oci8) HasIndex(tableName string, indexName string) bool { var count int tableName = strings.ToUpper(tableName) indexName = strings.ToUpper(indexName) if err := s.db.QueryRow("SELECT count(*) FROM ALL_INDEXES WHERE INDEX_NAME = :1 AND TABLE_NAME = :2", indexName, tableName).Scan(&count); err == nil { return count > 0 } return false } func (s oci8) HasTable(tableName string) bool { var count int _, tableName = currentDatabaseAndTable(&s, tableName) tableName = strings.ToUpper(tableName) if err := s.db.QueryRow("select count(*) from user_tables where table_name = :1", tableName).Scan(&count); err == nil { return count > 0 } return false } func (oci8) LastInsertIDReturningSuffix(tableName, columnName string) string { return "" } func (oci8) LastInsertIDOutputInterstitial(tableName, columnName string, columns []string) string { return "" } func (s oci8) ModifyColumn(tableName string, columnName string, typ string) error { _, err := s.db.Exec(fmt.Sprintf("ALTER TABLE %v MODIFY %v %v", tableName, columnName, typ)) return err } func (s oci8) RemoveIndex(tableName string, indexName string) error { _, err := s.db.Exec(fmt.Sprintf("DROP INDEX %v", indexName)) return err } func (oci8) SelectFromDummyTable() string { return "FROM DUAL" } func (s *oci8) SetDB(db gorm.SQLCommon) { s.db = db } func currentDatabaseAndTable(dialect gorm.Dialect, tableName string) (string, string) { if strings.Contains(tableName, ".") { splitStrings := strings.SplitN(tableName, ".", 2) return splitStrings[0], splitStrings[1] } return dialect.CurrentDatabase(), tableName } func (s *oci8) DataTypeOf(field *gorm.StructField) string { if _, found := field.TagSettingsGet("RESTRICT"); found { field.TagSettingsDelete("RESTRICT") } var dataValue, sqlType, size, additionalType = gorm.ParseFieldStructForDialect(field, s) if sqlType == "" { switch dataValue.Kind() { case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uintptr, reflect.Int64, reflect.Uint32, reflect.Uint64, reflect.Float32, reflect.Float64: if s.fieldCanAutoIncrement(field) { sqlType = "NUMBER GENERATED BY DEFAULT AS IDENTITY" } else { switch dataValue.Kind() { case reflect.Int8, reflect.Uint8, reflect.Uintptr: sqlType = "SHORTINTEGER" case reflect.Int, reflect.Int16, reflect.Int32, reflect.Uint, reflect.Uint16, reflect.Uint32: sqlType = "INTEGER" case reflect.Int64, reflect.Uint64: sqlType = "INTEGER" default: sqlType = "NUMBER" } } case reflect.Bool: sqlType = "INTEGER" case reflect.String: if _, ok := field.TagSettingsGet("SIZE"); !ok { size = 0 // if SIZE haven't been set, use `text` as the default type, as there are no performance different } switch { case size > 0 && size < 4000: sqlType = fmt.Sprintf("VARCHAR2(%d)", size) case size == 0: sqlType = "VARCHAR2 (1000)" // no size specified, so default to something that can be indexed default: sqlType = "CLOB" } case reflect.Struct: if _, ok := dataValue.Interface().(time.Time); ok { sqlType = "TIMESTAMP WITH TIME ZONE" } default: if gorm.IsByteArrayOrSlice(dataValue) { sqlType = "BLOB" } } } if strings.EqualFold(sqlType, "text") { sqlType = "CLOB" } if sqlType == "" { panic(fmt.Sprintf("invalid sql type %s (%s) for oracle", dataValue.Type().Name(), dataValue.Kind().String())) } if strings.TrimSpace(additionalType) == "" { return sqlType } if strings.EqualFold(sqlType, "json") { sqlType = "VARCHAR2 (4000)" } // For oracle, we have to redo the order of the Default type from tag setting notNull, _ := field.TagSettingsGet("NOT NULL") unique, _ := field.TagSettingsGet("UNIQUE") additionalType = notNull + " " + unique if value, ok := field.TagSettingsGet("DEFAULT"); ok { additionalType = fmt.Sprintf("%s %s %s", "DEFAULT", value, additionalType) } if value, ok := field.TagSettingsGet("COMMENT"); ok { additionalType = additionalType + " COMMENT " + value } return fmt.Sprintf("%v %v", sqlType, additionalType) } func (s oci8) LimitAndOffsetSQL(limit, offset interface{}) (sql string, err error) { if limit != nil { if parsedLimit, err := strconv.ParseInt(fmt.Sprint(limit), 0, 0); err == nil && parsedLimit >= 0 { // when only Limit() is called on a query, the offset is set to -1 for some reason if offset != nil && offset != -1 { if parsedOffset, err := strconv.ParseInt(fmt.Sprint(offset), 0, 0); err == nil && parsedOffset >= 0 { sql += fmt.Sprintf(" OFFSET %d ROWS ", parsedOffset) } else { return "", err } } sql += fmt.Sprintf(" FETCH NEXT %d ROWS ONLY", parsedLimit) } else { return "", err } } return } // NormalizeIndexAndColumn returns argument's index name and column name without doing anything func (oci8) NormalizeIndexAndColumn(indexName, columnName string) (string, string) { return indexName, columnName } func (oci8) CreateWithReturningInto(scope *gorm.Scope) { var stringId string var intId uint32 primaryField := scope.PrimaryField() primaryIsString := false out := sql.Out{ Dest: &intId, } if primaryField.Field.Kind() == reflect.String { out = sql.Out{ Dest: &stringId, } primaryIsString = true } scope.SQLVars = append(scope.SQLVars, out) scope.SQL = fmt.Sprintf("%s returning %s into :%d", scope.SQL, scope.Quote(primaryField.DBName), len(scope.SQLVars)) if result, err := scope.SQLDB().Exec(scope.SQL, scope.SQLVars...); scope.Err(err) == nil { scope.DB().RowsAffected, _ = result.RowsAffected() if primaryIsString { scope.Err(primaryField.Set(stringId)) } else { scope.Err(primaryField.Set(intId)) } } // this should raise an error, but the gorm.createCallback() which calls it simply doesn't support returning an error } // SearchBlob returns a where clause substring for searching fieldName and will require you to pass a parameter for the search value func SearchBlob(fieldName string) string { // oracle requires some hoop jumping to search []byte stored as BLOB const lobSearch = ` dbms_lob.instr (%s, -- the blob utl_raw.cast_to_raw (?), -- the search string cast to raw 1, -- where to start. i.e. offset 1 -- Which occurrance i.e. 1=first ) > 0 ` return fmt.Sprintf(lobSearch, fieldName) }