package driver

import "github.com/apache/arrow-go/v18/arrow/flight/flightsql/driver"

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index ¶

• Variables
• func GetTLSConfig(name string) (*tls.Config, bool)
• func RegisterTLSConfig(name string, cfg *tls.Config) error
• func UnregisterTLSConfig(name string) error
• type Connection
• func (c *Connection) Begin() (driver.Tx, error)
• func (c *Connection) BeginTx(ctx context.Context, opts sql.TxOptions) (driver.Tx, error)
• func (c *Connection) Close() error
• func (c *Connection) Prepare(query string) (driver.Stmt, error)
• func (c *Connection) PrepareContext(ctx context.Context, query string) (driver.Stmt, error)
• func (c *Connection) QueryContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Rows, error)
• type Connector
• func (c *Connector) Configure(config *DriverConfig) error
• func (c *Connector) Connect(ctx context.Context) (driver.Conn, error)
• func (c *Connector) Driver() driver.Driver
• type Driver
• func (d *Driver) Open(name string) (driver.Conn, error)
• func (d *Driver) OpenConnector(name string) (driver.Connector, error)
• type DriverConfig
• func NewDriverConfigFromDSN(dsn string) (*DriverConfig, error)
• func (config *DriverConfig) DSN() string
• type Result
• func (r *Result) LastInsertId() (int64, error)
• func (r *Result) RowsAffected() (int64, error)
• type Rows
• func (r *Rows) Close() error
• func (r *Rows) Columns() []string
• func (r *Rows) Next(dest []driver.Value) error
• type Stmt
• func (s *Stmt) Close() error
• func (s *Stmt) Exec(args []driver.Value) (driver.Result, error)
• func (s *Stmt) ExecContext(ctx context.Context, args []driver.NamedValue) (driver.Result, error)
• func (s *Stmt) NumInput() int
• func (s *Stmt) Query(args []driver.Value) (driver.Rows, error)
• func (s *Stmt) QueryContext(ctx context.Context, args []driver.NamedValue) (driver.Rows, error)
• type Tx
• func (t *Tx) Commit() error
• func (t *Tx) Rollback() error

Variables ¶

var (
	ErrNotSupported          = errors.New("not supported")
	ErrOutOfRange            = errors.New("index out of range")
	ErrTransactionInProgress = errors.New("transaction still in progress")
	ErrRegistryEntryExists   = errors.New("entry already exists")
	ErrRegistryNoEntry       = errors.New("entry not registered")
)

Functions ¶

func GetTLSConfig ¶

func GetTLSConfig(name string) (*tls.Config, bool)

func RegisterTLSConfig ¶

func RegisterTLSConfig(name string, cfg *tls.Config) error

func UnregisterTLSConfig ¶

func UnregisterTLSConfig(name string) error

Types ¶

type Connection ¶

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

func (*Connection) Begin ¶

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

Begin starts and returns a new transaction.

func (*Connection) BeginTx ¶

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

func (*Connection) Close ¶

func (c *Connection) Close() error

Close invalidates and potentially stops any current prepared statements and transactions, marking this connection as no longer in use.

func (*Connection) Prepare ¶

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

Prepare returns a prepared statement, bound to this connection.

func (*Connection) PrepareContext ¶

func (c *Connection) PrepareContext(ctx context.Context, query string) (driver.Stmt, error)

PrepareContext returns a prepared statement, bound to this connection. context is for the preparation of the statement, it must not store the context within the statement itself.

func (*Connection) QueryContext ¶

func (c *Connection) QueryContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Rows, error)

type Connector ¶

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

func (*Connector) Configure ¶

func (c *Connector) Configure(config *DriverConfig) error

Configure the driver with the corresponding config

func (*Connector) Connect ¶

func (c *Connector) Connect(ctx context.Context) (driver.Conn, error)

Connect returns a connection to the database.

func (*Connector) Driver ¶

func (c *Connector) Driver() driver.Driver

Driver returns the underlying Driver of the Connector, mainly to maintain compatibility with the Driver method on sql.DB.

type Driver ¶

type Driver struct{}

func (*Driver) Open ¶

func (d *Driver) Open(name string) (driver.Conn, error)

Open returns a new connection to the database.

func (*Driver) OpenConnector ¶

func (d *Driver) OpenConnector(name string) (driver.Connector, error)

OpenConnector must parse the name in the same format that Driver.Open parses the name parameter.

type DriverConfig ¶

type DriverConfig struct {
	Address  string
	Username string
	Password string
	Token    string
	Timeout  time.Duration
	Params   map[string]string

	TLSEnabled    bool
	TLSConfigName string
	TLSConfig     *tls.Config
}

func NewDriverConfigFromDSN ¶

func NewDriverConfigFromDSN(dsn string) (*DriverConfig, error)

func (*DriverConfig) DSN ¶

func (config *DriverConfig) DSN() string

type Result ¶

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

func (*Result) LastInsertId ¶

func (r *Result) LastInsertId() (int64, error)

LastInsertId returns the database's auto-generated ID after, for example, an INSERT into a table with primary key.

func (*Result) RowsAffected ¶

func (r *Result) RowsAffected() (int64, error)

RowsAffected returns the number of rows affected by the query.

type Rows ¶

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

func (*Rows) Close ¶

func (r *Rows) Close() error

Close closes the rows iterator.

func (*Rows) Columns ¶

func (r *Rows) Columns() []string

Columns returns the names of the columns.

func (*Rows) Next ¶

func (r *Rows) Next(dest []driver.Value) error

Next is called to populate the next row of data into the provided slice. The provided slice will be the same size as the Columns() are wide.

Next should return io.EOF when there are no more rows.

The dest should not be written to outside of Next. Care should be taken when closing Rows not to modify a buffer held in dest.

type Stmt ¶

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

func (*Stmt) Close ¶

func (s *Stmt) Close() error

Close closes the statement.

func (*Stmt) Exec ¶

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

Exec executes a query that doesn't return rows, such as an INSERT or UPDATE.

func (*Stmt) ExecContext ¶

func (s *Stmt) ExecContext(ctx context.Context, args []driver.NamedValue) (driver.Result, error)

ExecContext executes a query that doesn't return rows, such as an INSERT or UPDATE.

func (*Stmt) NumInput ¶

func (s *Stmt) NumInput() int

NumInput returns the number of placeholder parameters.

func (*Stmt) Query ¶

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

Query executes a query that may return rows, such as a SELECT.

func (*Stmt) QueryContext ¶

func (s *Stmt) QueryContext(ctx context.Context, args []driver.NamedValue) (driver.Rows, error)

QueryContext executes a query that may return rows, such as a SELECT.

type Tx ¶

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

func (*Tx) Commit ¶

func (t *Tx) Commit() error

func (*Tx) Rollback ¶

func (t *Tx) Rollback() error

Source Files ¶

config.go driver.go errors.go utils.go