go_ora

package module
v0.0.0-...-6811f16 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 12, 2023 License: MIT Imports: 34 Imported by: 0

README

go-ora

Pure go oracle client

note:
the original oracle drivers are very complex and contain many features which are difficult to add them at one time
your feedbacks are very important for this project to proceed
    - Use version 2 you will need to import github.com/sijms/go-ora/v2
    - V2 is more preferred for oracle servers 10.2 and above
    - I always update the driver fixing issues and add new features so
      always ensure that you get latest release
    - See examples for more help
version 2.7.4:
  • activate global timeout value to protect against block read/write if no timeout context specified
  • default value for timeout is 30 second you can change by passing one of the following ["TIMEOUT", "CONNECT TIMEOUT", "CONNECTION TIMEOUT"]
  • other feature/issues:
    • fix passing empty []byte{} will produce error
    • fix passing empty array as a parameter will produce error
    • return first binding error when the driver return ora-24381: error in DML array
version 2.7.3: Use database/sql fail over
  • use database/sql fail over by returning driver.ErrBadConn when connection interrupted
  • other features:
    • add support for RC4 encryption
version 2.7.2: Use golang structure as an oracle (output) parameters

all rules used for input will be required for output plus:

  • structure should be passed as a pointer
  • tag direction is required to be output or inout. size is used with some types like strings
  • each field will be translated to a parameter as follows
number      mapped to sql.NullFloat64
varchar     mapped to sql.NullString
nvarchar    mapped to sql.NullNVarchar
date        mapped to sql.NullTime
timestamp   mapped to NullTimeStamp
timestamptz mapped to NullTimeStampTZ
raw         mapped to []byte
clob        mapped to Clob
nclob       mapped to NClob
blob        mapped to Blob

all fields that support driver.Valuer interface will be passed as it is

  • data assigned back to structure fields after exec finish when a null value read then field value will set to reflect.Zero
  • examples/struct_pars/main.go contain full example for reading and writing struct pars
version 2.7.1: Use golang structure as an oracle (input) parameters
  • by define structure tag db now you can pass information to sql.Exec
  • data in db tag can be recognized by its position or as key=value
type TEMP_TABLE struct {
	// tag by position: db:"name,type,size,direction"
	Id    int      `db:"ID,number"`
	// tag as key=value: db:"size=size,name=name,dir=directiontype=type"
	Name  string   `db:"type=varchar,name=NAME"`
}
  • you should pass at least the name of the parameter to use this feature
  • input parameters need only name and type. if you omit type driver will use field value directly as input parameter. type is used to make some flexibility example use time.Time field and pass type=timestamp in this case timestamp will be used instead of default value for time.Time which is date
  • type can be one of the following:
number      mapped to golang types integer, float, string, bool
varchar     mapped to any golang types that can converted to string
nvarchar    mapped to any golang types that can converted to string
date        mapped to golang types time.Time and string
timestamp   mapped to golang types time.Time and string
timestamptz mapped to golang types time.Time and string
raw         mapped to golang types []byte and string
blob        mapped to golang types []byte and string
clob        mapped to any golang types that can converted to string
nclob       mapped to any golang types that can converted to string
  • other features:
    • tag for user defined type UDT changed from oracle to udt
    • add 2 url options give the client control weather to use encryption, data integrity or not
    urlOptions := map[string]string {
  // values can be "required", "accepted", "requested", and rejected"
  "encryption": "required",
  "data integrity": "rejected",
}
    • fix issue #350
version 2.6.17: Implement Bulk(Insert/Merge) in ExecContext
  • now you can make bulk (insert/merge) with sql driver Exec as follows:
    • declare sql text with Insert or Merge
    • pass all parameter as array
    • number of rows inserted will equal to the least array size
  • Named parameter is also supported
  • full code is present in examples/merge
version 2.6.16: Map RefCursor to sql.Rows
  • mapping RefCursor to sql.Rows will work with select/scan.
// TEMP_FUNC_316 is sql function that return RefCursor
sqlText := `SELECT TEMP_FUNC_316(10) from dual`

// use Query and don't use QueryRow
rows, err := conn.Query(sqlText)
if err != nil {
	return err
}

// closing the parent rows will automatically close cursor
defer rows.Close()

for rows.Next() {
    var cursor sql.Rows
	err = rows.Scan(&cursor)
	if err != nil {
		return err
	}
	var (
        id   int64
        name string
        val  float64
        date time.Time
    )
	
    // reading operation should be inside rows.Next
    for cursor.Next() {
        err = cursor.Scan(&id, &name, &val, &date)
        if err != nil {
            return err
        }
        fmt.Println("ID: ", id, "\tName: ", name, "\tval: ", val, "\tDate: ", date)
    }
}
  • complete code is present in examples/refcursor_to_rows/main.go
version 2.6.14: Add Support for Named Parameters
  • to switch on named parameter mode simply pass all your parameter to Query or Exec as sql.Named("name", Value)
  • if one of the parameter doesn't contain name the driver automatically switch to positional mode
  • parameter name in sql will be for example :pr1 and its value will be sql.Named("pr1", 1)
  • when using named parameters the order of the parameters is not important as the driver will re-arrange the parameter according to declaration in sql text
  • See examples/named_pars/main.go for example code
version 2.6.12: Add Client Charset option
  • this option will allow controlling string encoding and decoding at client level
  • so using this option you can define a charset for the client that is different from the server
  • client charset will work in the following situation
    • encoding sql text
    • decoding varchar column
    • encoding and decoding varchar parameters
    • encoding and decoding CLOB
  • nvarchar, nclob and server messages are excluded from client charset
  • code
urlOptions := map[string]string {
	// you can use also 
	//"charset": "UTF8",
	"client charset": "UTF8",
	"trace file": "trace.log",
}
connStr := go_ora.BuildUrl("server", 1521, "service", "", "", urlOptions)
version 2.6.9: Re-Code Failover
  • now failover start when receive the following error:
    • io.EOF
    • syscall.EPIPE
  • failover added for the following
    • Query
    • Fetch
    • Exec
    • Ping
    • Commit
    • Rollback
    • RefCursor Query
  • In all situation Failover will try to reconnect before returning error except in case of Query failover will reconnect + requery
version 2.6.8: Fix return long data type with lob prefetch option:
  • now you can return up to 0x3FFFFFFF of data from long coumn type
  • examples/long insert 0x3FFF bytes of data into long column and query it again
  • for large data size better use lob fetch=post
version 2.6.5: Add New Url Options (Language and Territory)
  • this will control the language of the server messages
urlOptions := map[string]string {
"language": "PORTUGUESE",
"territory": "BRAZILIAN",
}
url := go_ora.BuildUrl(server, port, service, user, password, urlOptions)
version 2.6.4: Add Support for TimeStamp with timezone
  • now you can use TimeStampTZ as input/output parameters to manage timestamp with timezone
  • see code in examples/timestamp_tz
version 2.6.2: Add Support for Lob Prefetch
  • now you can control how you need to get lob data
    • pre-fetch (default) = lob data is sent from the server before send lob locator
    • post-fetch = lob data is sent from the server after send lob locator (need network call)
  • you can do this using url options
urlOptions := map[string]string {
  "TRACE FILE": "trace.log",
  "LOB FETCH": "PRE", // other value "POST"
}
connStr := go_ora.BuildUrl("server", 1521, "service", "", "", urlOptions)
version 2.5.33: Add Support for Client Authentication
  • you should have server and client certificate store in wallets + working TCPS communication
  • create oracle user as follows:
CREATE USER "SSLCLIENT" IDENTIFIED EXTERNALLY AS 'CN=ORCLCLIENT';
  • configure sqlnet.ora in the server to use client authentication
SQLNET.AUTHENTICATION_SERVICES=(TCPS,NTS)
SSL_CLIENT_AUTHENTICATION=TRUE
  • now connect
urlOptions := map[string]string {
  "TRACE FILE": "trace.log",
  "AUTH TYPE":  "TCPS",
  "SSL": "TRUE",
  "SSL VERIFY": "FALSE",
  "WALLET": "PATH TO WALLET"
}
connStr := go_ora.BuildUrl("server", 2484, "service", "", "", urlOptions)
version 2.5.31: Add BulkCopy using DirectPath (experimental)
  • it is a way to insert large amount of rows in table or view
  • this feature use oracle direct path
  • this feature still not implemented for the following types:
    • LONG
    • CLOB
    • BLOB
  • for more help about using this feature return to bulk_copy example
version 2.5.19: Add Support for Kerberos5 Authentication
  • note that kerberos need an intact dns system
  • to test kerberos you need 3 machine
  • there is an example code for kerberos, but you need to call kinit user before using the example
urlOptions := map[string]string{
    "TRACE FILE": "trace.log",
    "AUTH TYPE":  "KERBEROS",
}
// note empty password
connStr := go_ora.BuildUrl("server", 1521, "service", "krb_user", "", urlOptions)

type KerberosAuth struct{}
func (kerb KerberosAuth) Authenticate(server, service string) ([]byte, error) {
    // see implementation in examples/kerberos
}
advanced_nego.SetKerberosAuth(&KerberosAuth{})
version 2.5.16: Add Support for cwallet.sso created with -auto_login_local option
  • note that this type of oracle wallets only work on the machine where they were created
version 2.5.14: Failover and wallet update
  • Exec will return error after connection restore
  • add new field WALLET PASSWORD to read ewallet.p12 file
version 2.5.13: Add Support For Failover (Experimental)
  • to use failover pass it into connection string as follow
urlOptions := map[string]string{
	"FAILOVER": "5",
	"TRACE FILE": "trace.log",
}
databaseUrl := go_ora.BuildUrl(server, port, service, user, password, urlOptions)
  • FAILOVER value is integer indicate how many times the driver will try to reconnect after lose connection default value = 0
  • failover will activated when stmt receive io.EOF error during read or write
  • FAILOVER work in 3 places:
    • Query when fail the driver will reconnect and re-query up to failover number.
    • Exec when fail the driver will reconnect up to failover times then return the error to avoid unintended re-execution.
    • Fetch when fail the driver will reconnect up to failover times then return the error (whatever failover success or fail)
version 2.4.28: Binary Double And Float Fix
  • Now you can read binary double and float without error issue#217
  • You can avoid calling cgo function user.Current() if you define environmental variable $USER
version 2.4.20: Query To Struct
  • you can query to struct that contain basic types (int, float, string, datetime) or any types that implement sql.Scanner interface
  • see query to struct example for more information
version 2.4.18: Add support for proxy user

if you need to connect with proxy user pass following connection string

oracle://proxy_user:proxy_password@host:port/service?proxy client name=schema_owner
version 2.4.8: JDBC connect string
  • Add new function go_ora.BuildJDBC
    // program will extract server, ports and protocol and build
    // connection table
    connStr := `(DESCRIPTION=
    (ADDRESS_LIST=
    	(LOAD_BALANCE=OFF)
        (FAILOVER=ON)
    	(address=(PROTOCOL=tcps)(host=localhost)(PORT=2484))
    	(address=(protocol=tcp)(host=localhost)(port=1521))
    )
    (CONNECT_DATA=
    	(SERVICE_NAME=service)
        (SERVER=DEDICATED)
    )
    (SOURCE_ROUTE=yes)
    )`
    // use urlOption to set other options like:
    // TRACE FILE = for debug
    // note SSL automatically set from connStr (address=...
    // SSL Verify = need to cancel certifiate verification
    // wallet path
    databaseUrl := go_ora.BuildJDBC(user, password, connStr, urlOptions)
    conn, err := sql.Open("oracle", databaseUrl)
	if err != nil {
		fmt.Println(err)
		return
	}
    err = conn.Ping()
	if err != nil {
		fmt.Println(err)
		return
	}
version 2.4.5: Support BFile
  • connect as sys and create directory object that refer to physical directory
  • grant read,write on directory 'dirName' to user
  • put text file in the directory with name = fileName
// create and open connection before use BFile
conn, err := go_ora.NewConnection(connStr)
// check for error
err = conn.Open()
// check for error
defer conn.Close()

// Create BFile object
file, err := go_ora.BFile(conn, dirName, fileName)
// check for error

// before use BFile it must be opened
err = file.Open()
// check for error
defer file.Close()

// does the file exist
exists, err := file.Exists()
// check for error

if exists {
    length, err := file.GetLength()
    // check for error
    
    // read all data
    data, err := file.Read()
    
    // read at position 2
    data, err = file.ReadFromPos(2)
    
    // read 5 bytes count start at position 2
    data, err = file.ReadBytesFromPos(2, 5)
  • you can pass BFile object as input parameter or receive it from query or output parameters for more detail see example bfile
version 2.4.4: Support for unix socket IPC

you can use this option if server and client on same linux machine by specify the following url option

urlOptions := map[string]string{
	// change the value according to your machine
	"unix socket": "/usr/tmp/.oracle/sEXTPROC1"
}
version 2.4.3: Input Parameter CLOB and BLOB Accept Large Data Size

you can pass input CLOB and BLOB with any data size up to data type limit

version 2.4.1: Add support for connection time out + context read and write

you can determine connection overall lifetime through url options

// set connection time for 3 second
urlOptions := map[string]string {
    "CONNECTION TIMEOUT": "3"
}
databaseUrl := go_ora.BuildUrl(server, port, service, user, password, urlOptions)

see context example for more help about using context

version 2.4.0: Add support for Arrays
  • add support for oracle associative array as input and output parameter type
  • add BulkInsert function which dramatically improve performance (> 10x) during insert
  • add support for nullable type in DataSet.Scan function
  • Bug fixes
  • examples (bulk_insert and arrays) contain explanation of use of this 2 major features
// sqlText: sql text with parameters
// rowNum: number of rows to insert
// columns: each column contain array of driver.Value size of column should
//          equal to rowNum
func (conn *Connection) BulkInsert(sqlText string, rowNum int, columns ...[]driver.Value) (*QueryResult, error)
version 2.3.5: Add support for OS Auth (Windows) With Password Hash

now you can pass password hash of the user instead of real password

source of hash:
  • windows registry
  • create the hash by md4(unicode(password)) passing hash through url option as follow
urlOptions := map[string]string {
	"OS HASH": "yourpasswordhash"
	// or
	"OS PassHash": "yourpasswordhash"
	// or
	"OS Password Hash": "yourpasswordhash"
}
note:

you can use NTSAuthInterface

type YourCustomNTSManager struct {
	NTSAuthDefault
}
func (nts *NTSAuthHash) ProcessChallenge(chaMsgData []byte, user, password string) ([]byte, error) {
    // password = get (extract) password hash from Windows registry
	return ntlmssp.ProcessChallengeWithHash(chaMsgData, user, password)
}
// now you can pass empty user and password to the driver
version 2.3.3: Add support for OS Auth (Windows)

you can see windows_os_auth example for more detail

  • NTS packets are supplied from the following github package: go-ntlmssp
  • empty username or password will suppose OS Auth by default
  • AUTH TYPE: "OS" optional
  • OS USER optional if omit the client will use logon user
  • OS PASS is obligatory to make OS Auth using NTS
  • DOMAIN optional for windows domain
  • AUTH SERV: "NTS" optional as NTS is automatically added if the client running on Windows machine
  • DBA PRIVILEGE: "SYSDBA" optional if you need a SYSDBA access
urlOptions := map[string]string{
    // automatically set if you pass an empty oracle user or password
    // otherwise you need to set it
    "AUTH TYPE": "OS",
    // operating system user if empty the driver will use logon user name
    "OS USER": user,
    // operating system password needed for os logon
     "OS PASS": password,
    // Windows system domain name
    "DOMAIN": domain,
    // NTS is the required for Windows os authentication
    // when you run the program from Windows machine it will be added automatically
    // otherwise you need to specify it
    "AUTH SERV": "NTS",
    // uncomment this option for debugging
    "TRACE FILE": "trace.log",
}
databaseUrl := go_ora.BuildUrl(server, port, service, "", "", urlOptions)
note (Remote OS Auth):
  • you can make OS Auth on the same machine (Windows Server) or different machine (Windows Server) and (Other Client) and in this situation you need to pass AUTH SERV: "NTS" as url parameter
note (advanced users):
  • You can use custom NTS auth manager by implementing the following interface
type NTSAuthInterface interface {
	NewNegotiateMessage(domain, machine string) ([]byte, error)
	ProcessChallenge(chaMsgData []byte, user, password string) ([]byte, error)
}
  • set newNTS auth manager before open the connection
go_ora.SetNTSAuth(newNTSManager)
  • advantage of custom manager: you may not need to provide OS Password. for example using .NET or Windows API code as original driver
// CustomStream will take data from NegotiateStream and give it to the driver
// through NewNegotiateMessage
// Then take data form the driver (Challenge Message) to NegotiateStream
// And return back Authentication msg to the driver through ProcessChallenge
// as you see here CredentialCache.DefaultNetworkCredentials will take auth data
// (username and password) from logon user
new NegotiateStream(new YourCustomStream(), true).AuthenticateAsClient(CredentialCache.DefaultNetworkCredentials, "", ProtectionLevel.None, TokenImpersonationLevel.Identification);

now you can define url that contain ipv6

url := go_ora.BuildUrl("::1", 1521, "service", "user", "password", nil)
url = "oracle://user:password@[::1]:1521/service"
version 2.3.0: Add support for Nullable types
  • support for nullable type in output parameters
  • add more nullable type NullTimeStamp and NullNVarChar
version 2.2.25: Add support for User Defined Type (UDT) as input and output parameter
  • see example udt_pars for more help
version 2.2.23: User Defined Type (UDT) as input parameters
  • Add support for UDT as input parameter
  • Add go_ora.Out struct with Size member to set output parameter size
version 2.2.22: Lob for output parameters
  • Add new types for output parameter which is go_ora.Clob and go_ora.Blob used for receiving Clob and Blob from output parameters see clob example for more details
  • Fix some issue related to reading output parameters
  • Fix issue related to reading user defined type UDT
version 2.2.19: improve lob reading with high prefetch rows value
  • Now Prefetch rows value is automatically calculated (when left with its default value = 25) according to column size
  • Reading lob is retarded until all record has been read this fix error happen when you try to read lob with large PREFETCH_ROWS value
version 2.2.9: add support for connect to multiple servers

define multiple server in 2 way

  • in url string options
// using url options
databaseURL := "oracle://user:pass@server1/service?server=server2&server=server3"
/* now the driver will try connection as follow
1- server1
2- server2
3- server3
*/
  • using BuildUrl function
urlOptions := map[string] string {
    "TRACE FILE": "trace.log",
    "SERVER": "server2, server3",
    "PREFETCH_ROWS": "500",
    //"SSL": "enable",
    //"SSL Verify": "false",
}
databaseURL := go_ora.BuildUrl(server1, 1521, "service", "user", "pass", urlOptions)
version 2.2.8: add OracleError class

OracleError carry error message from the server

version 2.2.7: Add support for user defined types
  • this feature is now tested against these oracle versions 10.2, 12.2, 19.3.
  • RegisterType function need extra parameter owner (oracle user who create the type).
version 2.2.6 (pre-release - experimental): Add support for user defined types

to use make the following (oracle 12c)

  • define custom type in the oracle
create or replace TYPE TEST_TYPE1 IS OBJECT 
( 
    TEST_ID NUMBER(6, 0),
    TEST_NAME VARCHAR2(10)
)
  • define struct in go with tag
type test1 struct {
    // note use int64 not int
    // all tagged fields should be exported 
    // tag name:field_name --> case insensitive
    Id int64       `oracle:"name:test_id"`
    Name string    `oracle:"name:test_name"`
}
  • connect to database
databaseURL := go_ora.BuildUrl("localhost", 1521, "service", "user", "pass", nil)
conn, err := sql.Open("oracle", databaseURL)
// check for err
err = conn.Ping()
// check for err
defer func() {
    err := conn.Close()
    // check for err
}()
  • register type
if drv, ok := conn.Driver().(*go_ora.OracleDriver); ok {
    err = drv.Conn.RegisterType("owner", "TEST_TYPE1", test1{})
    // check for err
}
  • select and display data
rows, err := conn.Query("SELECT test_type1(10, 'test') from dual")
// check for err
var test test1
for rows.Next() {
    err = rows.Scan(&test)
    // check for err
    fmt.Println(test)
}
version 2.2.5
  • add function go_ora.BuildUrl to escape special characters
version 2.2.4
  • add support for tcps. you can enable tcps through the following url options
  • this link explain how to enable tcps in your server
wallet=wallet_dir // wallet should contain server and client certificates
SSL=true          // true or enabled
SSL Verify=false  // to bypass certificate verification
version 2.1.23
  • now support auto-login oracle wallet (non-local)
  • note: to use wallet you need to specify directory path for wallet the directory should contain cwallet.sso file "the file that will be used"
sqlQuery := "oracle://user@127.0.0.1:1522/service"
sqlQuery += "?TRACE FILE=trace.log"
sqlQuery += "&wallet=path_to_wallet_directory"
conn, err := sql.open("oracle", sqlQuery)
server:port/service ---> should be supplied when using wallet
user ---> is optional when omitted the reader will return first matched dsn
password ---> should be empty as it will be supplied from wallet
version 2.1.22
  • now support data packet integrity check using MD5, SHA1, SHA256, SHA384, SHA512
  • key is exchanged between server and client using Diffie Hellman method
  • note: to enable data integrity check add the following line to sqlnet.ora of the server
# possible values ([accepted | rejected | requested | required])
SQLNET.CRYPTO_CHECKSUM_SERVER = required
# possible values ([MD5 | SHA1 | SHA256 | SHA384 | SHA512])
SQLNET.CRYPTO_CHECKSUM_TYPES_SERVER = SHA512
version 2.1.21
  • now support data packet encryption using AES.
  • key is exchanged between server and client using Diffie Hellman method
  • note: to enable AES encryption add the following line to sqlnet.ora of the server
# possible values ([accepted | rejected | requested | required])
SQLNET.ENCRYPTION_SERVER = required
# possible values for AES (AES256 | AES192 | AES128)
SQLNET.ENCRYPTION_TYPES_SERVER = AES256
version 2.1.20
  • add new type go_ora.NVarChar now you can pass string parameter in 2 way:
    1- varchar string:
_, err := conn.Exec(inputSql, "7586")
   2- nvarchar string:
_, err := conn.Exec(inputSql, go_ora.NVarChar("7586"))
version 2.1.19
  • support more charsets (0x33D, 0x33E, 0x33F, 0x340, 0x352, 0x353, 0x354)
version 2.0-beta
  • update client version to 317
  • update ttc version to: 9
  • use 4 byte packet length instead of 2 bytes
  • use advanced negotiation
  • use big clear chunks
  • use more verifier type in authentication object

Usage:

there are 2 way to use the client

A. Using sql/database interface
1- importing:
import (
  "database/sql"
  _ "github.com/sijms/go-ora/v2"
)
2- create the connection
conn, err := sql.Open("oracle", "oracle://user:pass@server/service_name")
// check for error
defer conn.Close()
3- create statment
stmt, err := conn.Prepare("SELECT col_1, col_2, col_3 FROM table WHERE col_1 = :1 or col_2 = :2")
// check for error
defer stmt.CLose()
4- query
// suppose we have 2 params one time.Time and other is double
rows, err := stmt.Query(time.Date(2020, 9, 1, 0, 0, 0, 0, time.UTC), 9.2)
// check for error
defer rows.Close()
5- extract data using next
 for rows.Next() {
    // define vars
    err = rows.Scan(/*vars here */)
    // check for error
 }
6- use exec instead of query for update and insert stmt
// i make change in parameter no 4 to explain that you can use string in parameter name instead of numbers
stmt, err := conn.Prepare("UPDATE table SET col_1=:1, col_2=:2 WHERE col_3 = :3 or col_4 = :col_4_par")
// check for error
defer stmt.Close()
result, err := stmt.Exec(/*pars value*/)
// check for error
fmt.Println(result.RowsAffected())
7- using transaction:
// after step 2 "Create Connection"
tx, err := conn.Begin()
// check for error
stmt, err := tx.Prepare("sql text")
// check for error
// continue as above
tx.Commit()
// or
tx.Rollback()
// note: any stmt created from conn will not be committed or rolled back
B. direct use of the package

the benefit here is that you can use pl/sql and output parameters

1- import go_ora "go-ora"
2- create connection
conn, err := go_ora.NewConnection("oracle://user:pass@server/service_name")
// check for error
err = conn.Open()
// check for error
defer conn.Close()
2- create stmt
stmt := go_ora.NewStmt("sql or pl/sql text", conn)
defer stmt.Close()
3- add parameters
stmt.AddParam("name", value, size, go_ora.Input /* or go_ora.Output*/)
// note that size is need when you define string output parameters
4- exec or query as above and pass nil for parameters
5- after that you can read the output parameters using Pars variable of stmt structure

Server's URL options

The complete syntax of connection url is:

oracle://user:pass@server/service_name[?OPTION1=VALUE1[&OPTIONn=VALUEn]...]

Check possible options in connection_string.go

TRACE FILE

This option enables logging driver activity and packet content into a file.

oracle://user:pass@server/service_name?TRACE FILE=trace.log

The log file is created into the current directory.

This produce this kind of log:

2020-11-22T07:51:42.8137: Open :(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=192.168.10.10)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=xe)(CID=(PROGRAM=C:\Users\Me\bin\hello_ora.exe)(HOST=workstation)(USER=Me))))
2020-11-22T07:51:42.8147: Connect
2020-11-22T07:51:42.8256: 
Write packet:
00000000  00 3a 00 00 01 00 00 00  01 38 01 2c 0c 01 ff ff  |.:.......8.,....|
00000010  ff ff 4f 98 00 00 00 01  00 ea 00 3a 00 00 00 00  |..O........:....|
00000020  04 04 00 00 00 00 00 00  00 00 00 00 00 00 00 00  |................|
00000030  00 00 00 00 00 00 00 00  00 00                    |..........|

...

2020-11-22T07:51:42.8705: Query:
SELECT * FROM v$version
2020-11-22T07:51:42.8705: 
Write packet:
00000000  00 55 00 00 06 00 00 00  00 00 03 5e 00 02 81 21  |.U.........^...!|
00000010  00 01 01 17 01 01 0d 00  00 00 01 19 01 01 00 00  |................|
00000020  00 00 00 00 00 00 00 00  00 01 00 00 00 00 00 53  |...............S|
00000030  45 4c 45 43 54 20 2a 20  46 52 4f 4d 20 76 24 76  |ELECT * FROM v$v|
00000040  65 72 73 69 6f 6e 01 01  00 00 00 00 00 00 01 01  |ersion..........|
00000050  00 00 00 00 00                                    |.....|
2020-11-22T07:51:42.9094: 
Read packet:
00000000  01 a7 00 00 06 00 00 00  00 00 10 17 3f d5 ec 21  |............?..!|
00000010  d5 37 e0 67 cc 0f eb 03  cc c5 d1 d8 78 78 0b 15  |.7.g........xx..|
00000020  0c 21 20 01 50 01 01 51  01 80 00 00 01 50 00 00  |.! .P..Q.....P..|
00000030  00 00 02 03 69 01 01 50  01 06 01 06 06 42 41 4e  |....i..P.....BAN|
00000040  4e 45 52 00 00 00 00 01  07 07 78 78 0b 16 07 34  |NER.......xx...4|
00000050  2b 00 02 1f e8 01 0a 01  0a 00 06 22 01 01 00 01  |+.........."....|
00000060  19 00 00 00 07 49 4f 72  61 63 6c 65 20 44 61 74  |.....IOracle Dat|
00000070  61 62 61 73 65 20 31 31  67 20 45 78 70 72 65 73  |abase 11g Expres|
00000080  73 20 45 64 69 74 69 6f  6e 20 52 65 6c 65 61 73  |s Edition Releas|
00000090  65 20 31 31 2e 32 2e 30  2e 32 2e 30 20 2d 20 36  |e 11.2.0.2.0 - 6|
000000a0  34 62 69 74 20 50 72 6f  64 75 63 74 69 6f 6e 07  |4bit Production.|
000000b0  26 50 4c 2f 53 51 4c 20  52 65 6c 65 61 73 65 20  |&PL/SQL Release |
000000c0  31 31 2e 32 2e 30 2e 32  2e 30 20 2d 20 50 72 6f  |11.2.0.2.0 - Pro|
000000d0  64 75 63 74 69 6f 6e 15  01 01 01 07 1a 43 4f 52  |duction......COR|
000000e0  45 09 31 31 2e 32 2e 30  2e 32 2e 30 09 50 72 6f  |E.11.2.0.2.0.Pro|
000000f0  64 75 63 74 69 6f 6e 15  01 01 01 07 2e 54 4e 53  |duction......TNS|
00000100  20 66 6f 72 20 4c 69 6e  75 78 3a 20 56 65 72 73  | for Linux: Vers|
00000110  69 6f 6e 20 31 31 2e 32  2e 30 2e 32 2e 30 20 2d  |ion 11.2.0.2.0 -|
00000120  20 50 72 6f 64 75 63 74  69 6f 6e 15 01 01 01 07  | Production.....|
00000130  26 4e 4c 53 52 54 4c 20  56 65 72 73 69 6f 6e 20  |&NLSRTL Version |
00000140  31 31 2e 32 2e 30 2e 32  2e 30 20 2d 20 50 72 6f  |11.2.0.2.0 - Pro|
00000150  64 75 63 74 69 6f 6e 08  01 06 03 14 97 b7 00 01  |duction.........|
00000160  01 01 02 00 00 00 00 00  04 01 05 01 07 01 05 02  |................|
00000170  05 7b 00 00 01 01 00 03  00 01 20 00 00 00 00 00  |.{........ .....|
00000180  00 00 00 00 00 00 00 01  01 00 00 00 00 19 4f 52  |..............OR|
00000190  41 2d 30 31 34 30 33 3a  20 6e 6f 20 64 61 74 61  |A-01403: no data|
000001a0  20 66 6f 75 6e 64 0a                              | found.|
2020-11-22T07:51:42.9104: Summary: RetCode:1403, Error Message:"ORA-01403: no data found\n"
2020-11-22T07:51:42.9104: Row 0
2020-11-22T07:51:42.9104:   BANNER              : Oracle Database 11g Express Edition Release 11.2.0.2.0 - 64bit Production
2020-11-22T07:51:42.9104: Row 1
2020-11-22T07:51:42.9104:   BANNER              : PL/SQL Release 11.2.0.2.0 - Production
2020-11-22T07:51:42.9104: Row 2
2020-11-22T07:51:42.9104:   BANNER              : CORE	11.2.0.2.0	Production
2020-11-22T07:51:42.9104: Row 3
2020-11-22T07:51:42.9104:   BANNER              : TNS for Linux: Version 11.2.0.2.0 - Production
2020-11-22T07:51:42.9104: Row 4
2020-11-22T07:51:42.9104:   BANNER              : NLSRTL Version 11.2.0.2.0 - Production
2020-11-22T07:51:42.9114:
PREFETCH_ROWS

Default value is 25 increase this value to higher level will significantly speed up the query

RefCursor

note: See examples for using RefCursor with sql package

to use RefCursor follow these steps:

  • create the connection object and open
  • create NewStmt from connection
  • pass RefCursorParam
  • cast parameter to go_ora.RefCursor
  • call cursor.Query()
  • reterive records use for loop
code:
urlOptions := map[string] string {
	"trace file": "trace.log" ,
}
databaseURL := go_ora.BuildUrl(server, port, service, user, password, urlOptions)
conn, err := sql.Open("oracle", databaseURL)
// check error

err = conn.Ping()
// check error

defer conn.Close()

cmdText := `BEGIN    
    proc_1(:1); 
end;`
var cursor go_ora.RefCursor
_, err = conn.Exec(cmdText, sql.Out{Dest: &cursor})
//check errors

defer cursor.Close()
rows, err := cursor.Query()
// check for error

var (
    var_1 int64
    var_2 string
)
for rows.Next_() {
    err = rows.Scan(&var_1, &var_2)
    // check for error
	fmt.Println(var_1, var_2)
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildJDBC 

func BuildJDBC(user, password, connStr string, options map[string]string) string

BuildJDBC create url from user, password and JDBC description string

func BuildUrl 

func BuildUrl(server string, port int, service, user, password string, options map[string]string) string

BuildUrl create databaseURL from server, port, service, user, password, urlOptions this function help build a will formed databaseURL and accept any character as it convert special charters to corresponding values in URL

func CalculateKeysHash 

func CalculateKeysHash(verifierType int, key1 []byte, key2 []byte) ([]byte, error)

func EncryptPassword 

func EncryptPassword(password string, key []byte) (string, error)

func EncryptSessionKey 

func EncryptSessionKey(padding bool, encKey []byte, sessionKey []byte) (string, error)

func NewWallet 

func NewWallet(filePath string) (*wallet, error)

NewWallet create new wallet object from file path

func PKCS5Padding 

func PKCS5Padding(cipherText []byte, blockSize int) []byte

func SetNTSAuth 

func SetNTSAuth(newNTSManager advanced_nego.NTSAuthInterface)

func TZBytes 

func TZBytes() []byte

Types

type AuthObject 

type AuthObject struct {
	EServerSessKey string
	EClientSessKey string
	EPassword      string
	ServerSessKey  []byte
	ClientSessKey  []byte
	KeyHash        []byte
	Salt           string
	VerifierType   int
	// contains filtered or unexported fields
}

E infront of the variable means encrypted

func NewAuthObject 

func NewAuthObject(username string, password string, tcpNego *TCPNego, session *network.Session) (*AuthObject, error)

func (*AuthObject) VerifyResponse 

func (obj *AuthObject) VerifyResponse(response string) bool

func (*AuthObject) Write 

func (obj *AuthObject) Write(connOption *network.ConnectionOption, mode LogonMode, session *network.Session) error

type AuthType 

type AuthType int
const (
	Normal AuthType = 0
	OS     AuthType = 1
)

type Connection 

type Connection struct {
	State     ConnectionState
	LogonMode LogonMode

	SessionProperties map[string]string

	NLSData NLSData
	// contains filtered or unexported fields
}

func NewConnection 

func NewConnection(databaseUrl string) (*Connection, error)

func (*Connection) Begin 

func (conn *Connection) Begin() (driver.Tx, error)

func (*Connection) BeginTx 

func (conn *Connection) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, error)

func (*Connection) Close 

func (conn *Connection) Close() (err error)

func (*Connection) GetNLS 

func (conn *Connection) GetNLS() (*NLSData, error)

func (*Connection) Open 

func (conn *Connection) Open() error

func (*Connection) OpenWithContext 

func (conn *Connection) OpenWithContext(ctx context.Context) error

func (*Connection) Ping 

func (conn *Connection) Ping(ctx context.Context) error

func (*Connection) Prepare 

func (conn *Connection) Prepare(query string) (driver.Stmt, error)

func (*Connection) SetStringConverter 

func (conn *Connection) SetStringConverter(converter converters.IStringConverter)

type ConnectionState 

type ConnectionState int
const (
	Closed ConnectionState = 0
	Opened ConnectionState = 1
)

type ConnectionString 

type ConnectionString struct {
	DataSource   string
	Host         string
	Port         int
	DBAPrivilege DBAPrivilege

	Trace      string // Trace file
	WalletPath string
	// contains filtered or unexported fields
}

type DBAPrivilege 

type DBAPrivilege int
const (
	NONE    DBAPrivilege = 0
	SYSDBA  DBAPrivilege = 0x20
	SYSOPER DBAPrivilege = 0x40
)

func DBAPrivilegeFromString 

func DBAPrivilegeFromString(s string) DBAPrivilege

type DBVersion 

type DBVersion struct {
	Info            string
	Text            string
	Number          uint16
	MajorVersion    int
	MinorVersion    int
	PatchsetVersion int
	// contains filtered or unexported fields
}

func GetDBVersion 

func GetDBVersion(session *network.Session) (*DBVersion, error)

type DataSet 

type DataSet struct {
	ColumnCount     int
	RowCount        int
	UACBufferLength int
	MaxRowSize      int
	Cols            []ParameterInfo
	Rows            []Row
	// contains filtered or unexported fields
}

func (*DataSet) Close 

func (dataSet *DataSet) Close() error

func (DataSet) ColumnTypeDatabaseTypeName 

func (dataSet DataSet) ColumnTypeDatabaseTypeName(index int) string

func (DataSet) ColumnTypeLength 

func (dataSet DataSet) ColumnTypeLength(index int) (length int64, ok bool)

func (DataSet) ColumnTypeNullable 

func (dataSet DataSet) ColumnTypeNullable(index int) (nullable, ok bool)

func (*DataSet) Columns 

func (dataSet *DataSet) Columns() []string

func (*DataSet) Next 

func (dataSet *DataSet) Next(dest []driver.Value) error

func (DataSet) Trace 

func (dataSet DataSet) Trace(t trace.Tracer)

type DataTypeNego 

type DataTypeNego struct {
	MessageCode        uint8
	Server             *TCPNego
	TypeAndRep         []int16
	RuntimeTypeAndRep  []int16
	DataTypeRepFor1100 int16
	DataTypeRepFor1200 int16
	CompileTimeCaps    []byte
	RuntimeCap         []byte
	DBTimeZone         []byte
	// contains filtered or unexported fields
}

type Lob 

type Lob struct {
	// contains filtered or unexported fields
}

type LogonMode 

type LogonMode int
const (
	NoNewPass LogonMode = 0x1
	//WithNewPass LogonMode = 0x2
	SysDba      LogonMode = 0x20 // no verify response from server
	SysOper     LogonMode = 0x40 // no verify response from server
	UserAndPass LogonMode = 0x100
)

type NLSData 

type NLSData struct {
	Calender        string
	Comp            string
	Language        string
	LengthSemantics string
	NCharConvExcep  string
	DateLang        string
	Sort            string
	Currency        string
	DateFormat      string
	IsoCurrency     string
	NumericChars    string
	DualCurrency    string
	Timestamp       string
	TimestampTZ     string
}

type OracleConnector 

type OracleConnector struct {
	// contains filtered or unexported fields
}

func (*OracleConnector) Connect 

func (connector *OracleConnector) Connect(ctx context.Context) (driver.Conn, error)

func (*OracleConnector) Driver 

func (connector *OracleConnector) Driver() driver.Driver

type OracleDriver 

type OracleDriver struct {
}

func (*OracleDriver) Open 

func (drv *OracleDriver) Open(name string) (driver.Conn, error)

func (*OracleDriver) OpenConnector 

func (drv *OracleDriver) OpenConnector(name string) (driver.Connector, error)

type OracleType 

type OracleType int
const (
	NCHAR            OracleType = 1
	NUMBER           OracleType = 2
	SB1              OracleType = 3
	SB2              OracleType = 3
	SB4              OracleType = 3
	FLOAT            OracleType = 4
	NullStr          OracleType = 5
	VarNum           OracleType = 6
	LONG             OracleType = 8
	VARCHAR          OracleType = 9
	ROWID            OracleType = 11
	DATE             OracleType = 12
	VarRaw           OracleType = 15
	BFloat           OracleType = 21
	BDouble          OracleType = 22
	RAW              OracleType = 23
	LongRaw          OracleType = 24
	UINT             OracleType = 68
	LongVarChar      OracleType = 94
	LongVarRaw       OracleType = 95
	CHAR             OracleType = 96
	CHARZ            OracleType = 97
	IBFloat          OracleType = 100
	IBDouble         OracleType = 101
	REFCURSOR        OracleType = 102
	NOT              OracleType = 108
	XMLType          OracleType = 108
	OCIRef           OracleType = 110
	OCIClobLocator   OracleType = 112
	OCIBlobLocator   OracleType = 113
	OCIFileLocator   OracleType = 114
	ResultSet        OracleType = 116
	OCIString        OracleType = 155
	OCIDate          OracleType = 156
	TimeStampDTY     OracleType = 180
	TimeStampTZ_DTY  OracleType = 181
	IntervalYM_DTY   OracleType = 182
	IntervalDS_DTY   OracleType = 183
	TimeTZ           OracleType = 186
	TimeStamp        OracleType = 187
	TimeStampTZ      OracleType = 188
	IntervalYM       OracleType = 189
	IntervalDS       OracleType = 190
	UROWID           OracleType = 208
	TimeStampLTZ_DTY OracleType = 231
	TimeStampeLTZ    OracleType = 232
)

func (OracleType) String 

func (i OracleType) String() string

type ParameterDirection 

type ParameterDirection int
const (
	Input  ParameterDirection = 1
	Output ParameterDirection = 2
	InOut  ParameterDirection = 3
	RetVal ParameterDirection = 9
)

type ParameterInfo 

type ParameterInfo struct {
	Name                 string
	Direction            ParameterDirection
	IsNull               bool
	AllowNull            bool
	ColAlias             string
	DataType             OracleType
	IsXmlType            bool
	Flag                 uint8
	Precision            uint8
	Scale                uint8
	MaxLen               int
	MaxCharLen           int
	MaxNoOfArrayElements int
	ContFlag             int
	ToID                 []byte
	Version              int
	CharsetID            int
	CharsetForm          int
	BValue               []byte
	Value                driver.Value
	// contains filtered or unexported fields
}

type ParameterType 

type ParameterType int
const (
	Number ParameterType = 1
	String ParameterType = 2
)

type PromotableTransaction 

type PromotableTransaction int

type QueryResult 

type QueryResult struct {
	// contains filtered or unexported fields
}

func (*QueryResult) LastInsertId 

func (rs *QueryResult) LastInsertId() (int64, error)

func (*QueryResult) RowsAffected 

func (rs *QueryResult) RowsAffected() (int64, error)

type RefCursor 

type RefCursor struct {
	MaxRowSize int
	// contains filtered or unexported fields
}

func (*RefCursor) Close 

func (cursor *RefCursor) Close() error

func (*RefCursor) Query 

func (cursor *RefCursor) Query() (*DataSet, error)

type Row 

type Row []driver.Value

type Stmt 

type Stmt struct {
	// contains filtered or unexported fields
}

func NewStmt 

func NewStmt(text string, conn *Connection) *Stmt

func (*Stmt) AddParam 

func (stmt *Stmt) AddParam(name string, val driver.Value, size int, direction ParameterDirection)

func (*Stmt) AddRefCursorParam 

func (stmt *Stmt) AddRefCursorParam(_ string)

func (*Stmt) Close 

func (stmt *Stmt) Close() error

func (*Stmt) Exec 

func (stmt *Stmt) Exec(args []driver.Value) (driver.Result, error)

func (*Stmt) NewParam 

func (stmt *Stmt) NewParam(name string, val driver.Value, size int, direction ParameterDirection) *ParameterInfo

func (*Stmt) NumInput 

func (stmt *Stmt) NumInput() int

func (*Stmt) Query 

func (stmt *Stmt) Query(args []driver.Value) (driver.Rows, error)

func (stmt *Stmt) reExec() (driver.Rows, error) {

}

type StmtInterface 

type StmtInterface interface {
	// contains filtered or unexported methods
}

type StmtType 

type StmtType int
const (
	SELECT StmtType = 1
	DML    StmtType = 2
	PLSQL  StmtType = 3
	OTHERS StmtType = 4
)

type TCPNego 

type TCPNego struct {
	MessageCode           uint8
	ProtocolServerVersion uint8
	ProtocolServerString  string
	OracleVersion         int
	ServerCharset         int
	ServerFlags           uint8
	CharsetElem           int
	ServernCharset        int
	ServerCompileTimeCaps []byte
	ServerRuntimeCaps     []byte
}

type Transaction 

type Transaction struct {
	// contains filtered or unexported fields
}

func (*Transaction) Commit 

func (tx *Transaction) Commit() error

func (*Transaction) Rollback 

func (tx *Transaction) Rollback() error

Source Files

View all Source files

Directories

Path Synopsis
ntlmssp
Package ntlmssp provides NTLM/Negotiate authentication over HTTP
 Package ntlmssp provides NTLM/Negotiate authentication over HTTP
generatefloat
examples
UDT
arrays
bfile
bulk_copy
bulk_insert
clob
context
crud
emoji
exec
hello_ora
hello_ora_wallet
hello_sql
inout
insert_return
issue_319
issue_320
issue_321
issue_322
issue_329
issue_333
issue_343
issue_350
kerberos
long
merge
merge_async
named_pars
nclob
oracle_9_auth
output_pars
query
query_to_struct
refcursor
refcursor_to_rows
stored_proc
struct_par
structsinsert
timeout
timestamp_tz
udt_pars
urloptions
using_with
windows_os_auth
security
security/md4
Package md4 implements the MD4 hash algorithm as defined in RFC 1320.
 Package md4 implements the MD4 hash algorithm as defined in RFC 1320.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.