github.com/kaleido-io/firefly@v0.0.0-20210622132723-8b4b6aacb971/internal/database/ql/ql.go (about)

     1  // Copyright © 2021 Kaleido, Inc.
     2  //
     3  // SPDX-License-Identifier: Apache-2.0
     4  //
     5  // Licensed under the Apache License, Version 2.0 (the "License");
     6  // you may not use this file except in compliance with the License.
     7  // You may obtain a copy of the License at
     8  //
     9  //     http://www.apache.org/licenses/LICENSE-2.0
    10  //
    11  // Unless required by applicable law or agreed to in writing, software
    12  // distributed under the License is distributed on an "AS IS" BASIS,
    13  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14  // See the License for the specific language governing permissions and
    15  // limitations under the License.
    16  
    17  package ql
    18  
    19  import (
    20  	"context"
    21  	"fmt"
    22  
    23  	"database/sql"
    24  
    25  	sq "github.com/Masterminds/squirrel"
    26  	migratedb "github.com/golang-migrate/migrate/v4/database"
    27  	migrateql "github.com/golang-migrate/migrate/v4/database/ql"
    28  	"github.com/kaleido-io/firefly/internal/config"
    29  	"github.com/kaleido-io/firefly/internal/database/sqlcommon"
    30  	"github.com/kaleido-io/firefly/pkg/database"
    31  
    32  	// Import QL driver
    33  	_ "modernc.org/ql/driver"
    34  )
    35  
    36  type QL struct {
    37  	sqlcommon.SQLCommon
    38  }
    39  
    40  func (ql *QL) Init(ctx context.Context, prefix config.Prefix, callbacks database.Callbacks) error {
    41  	capabilities := &database.Capabilities{}
    42  	return ql.SQLCommon.Init(ctx, ql, prefix, callbacks, capabilities)
    43  }
    44  
    45  func (ql *QL) Name() string {
    46  	return "ql"
    47  }
    48  
    49  func (ql *QL) PlaceholderFormat() sq.PlaceholderFormat {
    50  	return sq.Dollar
    51  }
    52  
    53  func (ql *QL) UpdateInsertForSequenceReturn(insert sq.InsertBuilder) (sq.InsertBuilder, bool) {
    54  	// No tweaking needed, as QL supports the Go semantic for returning the id() from insert
    55  	return insert, false
    56  }
    57  
    58  func (ql *QL) SequenceField(tableName string) string {
    59  	return fmt.Sprintf("id(%s)", tableName)
    60  }
    61  
    62  func (ql *QL) Open(url string) (*sql.DB, error) {
    63  	return sql.Open(ql.Name(), url)
    64  }
    65  
    66  func (ql *QL) GetMigrationDriver(db *sql.DB) (migratedb.Driver, error) {
    67  	return migrateql.WithInstance(db, &migrateql.Config{})
    68  }