Squirrel

https://pkg.go.dev/github.com/Masterminds/squirrel
Admin
Squirrel is a fluent SQL query generator for Go that helps developers build SQL queries from...
Tokens:40,857
Snippets:546
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### FROM Clause Example

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Illustrates how to set the FROM clause for a SELECT query.

```go
func (b SelectBuilder) From(from string) SelectBuilder
```

--------------------------------

### Example of SelectBuilder Columns

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

This example demonstrates how to use the Columns method to specify columns for a SELECT statement.

```sql
SELECT id, created, first_name FROM users
```

--------------------------------

### Use Statement Cache and Builder

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Utilize StmtCache for prepared statement caching and StatementBuilder for a cleaner syntax. This example demonstrates initializing a builder with a cached database connection.

```go
// StmtCache caches Prepared Stmts for you
dbCache := sq.NewStmtCache(db)

// StatementBuilder keeps your syntax neat
mydb := sq.StatementBuilder.RunWith(dbCache)
select_users := mydb.Select("*").From("users")


```

--------------------------------

### Import Squirrel Package

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Import the Squirrel package to start using its functionalities for building SQL queries.

```go
import "github.com/Masterminds/squirrel"

```

--------------------------------

### Build an INSERT Query

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Create an INSERT statement with multiple rows. This example shows inserting static values and using an expression for one of the values.

```go
sql, args, err := sq.
    Insert("users").Columns("name", "age").
    Values("moe", 13).Values("larry", sq.Expr("? + 5", 12)).
    ToSql()

sql == "INSERT INTO users (name,age) VALUES (?,?),(?,? + 5)"

```

--------------------------------

### Get SQL string and args from InsertBuilder (panics on error)

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

MustSql builds the query into a SQL string and bound args. It panics if there are any errors during the build process.

```go
func (b InsertBuilder) MustSql() (string, []interface{})
```

--------------------------------

### Gt Type and Example

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Gt is syntactic sugar for greater than conditions. Example: .Where(Gt{"id": 1}) results in "id > 1".

```go
type Gt Lt
```

```go
.Where(Gt{"id": 1}) == "id > 1"


```

--------------------------------

### Use NotEq for Not Equal To Conditions

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Use NotEq for syntactic sugar with Where/Having/Set methods to specify not equal to conditions. Example: `.Where(NotEq{"id": 1}) == "id <> 1"`.

```go
type NotEq Eq
```

```go
.Where(NotEq{"id": 1}) == "id <> 1"
```

--------------------------------

### GtOrEq Type and Example

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

GtOrEq is syntactic sugar for greater than or equal to conditions. Example: .Where(GtOrEq{"id": 1}) results in "id >= 1".

```go
type GtOrEq Lt
```

```go
.Where(GtOrEq{"id": 1}) == "id >= 1"


```

--------------------------------

### Use Lt for Less Than Conditions

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Use Lt for syntactic sugar with Where/Having/Set methods to specify less than conditions. Example: `.Where(Lt{"id": 1})`.

```go
type Lt map[string]interface{}
```

```go
.Where(Lt{"id": 1})
```

--------------------------------

### Generating a DELETE Statement

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Use the Delete function to start building a DELETE query. Specify the table with From and add conditions with Where.

```go
db.Delete("users").Where("active = ?", true).Limit(10).ToSql()

```

--------------------------------

### Use NotILike for Case-Insensitive Not Like Conditions

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Use NotILike for syntactic sugar with ILIKE conditions to specify case-insensitive not like patterns. Example: `.Where(NotILike{"name": "sq%"})`.

```go
type NotILike Like
```

```go
.Where(NotILike{"name": "sq%"})
```

--------------------------------

### Use NotLike for Not Like Conditions

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Use NotLike for syntactic sugar with LIKE conditions to specify not like patterns. Example: `.Where(NotLike{"name": "%irrel"})`.

```go
type NotLike Like
```

```go
.Where(NotLike{"name": "%irrel"})
```

--------------------------------

### ToSql Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Builds the query into a SQL string and its bound arguments.

```go
func (b SelectBuilder) ToSql() (string, []interface{}, error)
```

--------------------------------

### Build SQL String and Arguments

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Builds the query into a SQL string and bound arguments. This method is useful for inspecting the generated SQL before execution.

```go
func (b UpdateBuilder) ToSql() (string, []interface{}, error)
```

--------------------------------

### Implement ToSql for And

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Implements the ToSql method for the And type.

```go
func (a And) ToSql() (string, []interface{}, error)
```

--------------------------------

### From Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

From sets the table from which records will be deleted.

```go
func (b DeleteBuilder) From(from string) DeleteBuilder
```

--------------------------------

### Define And Conjunction

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

And conjunction Sqlizers.

```go
type And conj
```

--------------------------------

### Set Placeholder Format

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Sets the PlaceholderFormat (e.g., Question or Dollar) for the query. This is important for database compatibility.

```go
func (b UpdateBuilder) PlaceholderFormat(f PlaceholderFormat) UpdateBuilder
```

--------------------------------

### PreparerContext Interface

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

The PreparerContext interface extends Preparer with a context-aware PrepareContext method.

```go
type PreparerContext interface {
	Preparer
	PrepareContext(ctx context.Context, query string) (*sql.Stmt, error)
}
```

--------------------------------

### StmtCache PrepareContext Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Prepares a SQL statement with context, caches it, and returns the prepared statement.

```go
func (sc *StmtCache) PrepareContext(ctx context.Context, query string) (*sql.Stmt, error)
```

--------------------------------

### Define DBProxyBeginner Interface

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

DBProxyBeginner groups the DBProxy interface and the Begin method.

```go
type DBProxyBeginner interface {
	DBProxy
	Begin() (*sql.Tx, error)
}
```

--------------------------------

### Build SQL String with ToSql for CaseBuilder

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

ToSql builds the query into a SQL string and bound args.

```go
func (b CaseBuilder) ToSql() (string, []interface{}, error)
```

--------------------------------

### Use LtOrEq for Less Than or Equal To Conditions

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Use LtOrEq for syntactic sugar with Where/Having/Set methods to specify less than or equal to conditions. Example: `.Where(LtOrEq{"id": 1}) == "id <= 1"`.

```go
type LtOrEq Lt
```

```go
.Where(LtOrEq{"id": 1}) == "id <= 1"
```

--------------------------------

### StmtCache Prepare Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Prepares a SQL statement, caches it using the query string as a key, and returns the prepared statement.

```go
func (sc *StmtCache) Prepare(query string) (*sql.Stmt, error)
```

--------------------------------

### PreparerContext Interface

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Interface for preparing SQL statements with context.

```APIDOC
## type PreparerContext

### Description
PrepareerContext is the interface that wraps the Prepare and PrepareContext methods. Prepare executes the given query as implemented by database/sql.Prepare. PrepareContext executes the given query as implemented by database/sql.PrepareContext.

### Interface Methods
- **Prepare(query string) (*sql.Stmt, error)**: Prepares a SQL statement.
- **PrepareContext(ctx context.Context, query string) (*sql.Stmt, error)**: Prepares a SQL statement with context.
```

--------------------------------

### Build a SELECT Query

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Construct a SELECT statement by chaining methods to specify columns, table, and join conditions. The generated SQL can be retrieved along with its arguments.

```go
import sq "github.com/Masterminds/squirrel"

users := sq.Select("*").From("users").Join("emails USING (email_id)")

active := users.Where(sq.Eq{"deleted_at": nil})

sql, args, err := active.ToSql()

sql == "SELECT * FROM users JOIN emails USING (email_id) WHERE deleted_at IS NULL"

```

--------------------------------

### ToSql Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

ToSql builds the DELETE query into a SQL string and bound arguments.

```go
func (b DeleteBuilder) ToSql() (string, []interface{}, error)
```

--------------------------------

### Building an IN Query on Composite Keys

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Use a series of OR conditions with Eq clauses to simulate an IN query on composite keys when direct tuple support is unavailable.

```go
sq.Or{
  sq.Eq{"col1": 1, "col2": 2},
  sq.Eq{"col1": 3, "col2": 4}}

```

--------------------------------

### Prefix Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Prefix adds an expression to the beginning of the DELETE query.

```go
func (b DeleteBuilder) Prefix(sql string, args ...interface{}) DeleteBuilder
```

--------------------------------

### Query Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Query builds and executes the DELETE query, returning the SQL rows.

```go
func (b DeleteBuilder) Query() (*sql.Rows, error)
```

--------------------------------

### Configure PostgreSQL Placeholder Format

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Set the placeholder format for PostgreSQL queries using PlaceholderFormat(sq.Dollar). This changes placeholders from '?' to '$1', '$2', etc.

```go
psql := sq.StatementBuilder.PlaceholderFormat(sq.Dollar)

// You use question marks for placeholders...
sql, _, _ := psql.Select("*").From("elephants").Where("name IN (?,?)", "Dumbo", "Verna").ToSql()

/// ...squirrel replaces them using PlaceholderFormat.
sql == "SELECT * FROM elephants WHERE name IN ($1,$2)"


```

--------------------------------

### Create CaseBuilder with Case

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Case returns a new CaseBuilder. 'what' represents the case value.

```go
func Case(what ...interface{}) CaseBuilder
```

--------------------------------

### StmtCache Exec Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Executes a query using a prepared statement from the cache, delegating to the underlying Preparer.

```go
func (sc *StmtCache) Exec(query string, args ...interface{}) (res sql.Result, err error)
```

--------------------------------

### StmtCache ExecContext Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Executes a query with context using a prepared statement from the cache, delegating to the underlying PreparerContext.

```go
func (sc *StmtCache) ExecContext(ctx context.Context, query string, args ...interface{}) (res sql.Result, err error)
```

--------------------------------

### StmtCache.PrepareContext

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Prepares a SQL statement with context.

```APIDOC
## StmtCache.PrepareContext

### Description
Prepares a SQL statement with context.

### Method
POST

### Endpoint
`/stmt_cache/prepare_context`

### Parameters
#### Query Parameters
- **ctx** (context.Context) - Required - The context for the preparation.
#### Request Body
- **query** (string) - Required - The SQL query to prepare.

### Response
#### Success Response (200)
- **sql.Stmt** (object) - The prepared statement.
- **error** (error) - An error if the statement preparation failed.
```

--------------------------------

### SelectBuilder.ToSql

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Returns the generated SQL string and arguments.

```APIDOC
## SelectBuilder.ToSql

### Description
Returns the generated SQL string and arguments.

### Method
GET

### Endpoint
`/select/to_sql`

### Response
#### Success Response (200)
- **string** (string) - The generated SQL query.
- **[]interface{}** ([]interface{}) - The arguments for the SQL query.
- **error** (error) - An error if the SQL generation failed.
```

--------------------------------

### StmtCache.Prepare

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Prepares a SQL statement.

```APIDOC
## StmtCache.Prepare

### Description
Prepares a SQL statement.

### Method
POST

### Endpoint
`/stmt_cache/prepare`

### Parameters
#### Request Body
- **query** (string) - Required - The SQL query to prepare.

### Response
#### Success Response (200)
- **sql.Stmt** (object) - The prepared statement.
- **error** (error) - An error if the statement preparation failed.
```

--------------------------------

### Preparer Interface

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

The Preparer interface defines a method for preparing SQL statements, similar to database/sql.Prepare.

```go
type Preparer interface {
	Prepare(query string) (*sql.Stmt, error)
}
```

--------------------------------

### ExecContext Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

ExecContext builds and executes the DELETE query using the provided context and runner.

```go
func (b DeleteBuilder) ExecContext(ctx context.Context) (sql.Result, error)
```

--------------------------------

### SelectBuilder.From

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Specifies the table to select from.

```APIDOC
## SelectBuilder.From

### Description
Specifies the table to select from.

### Method
POST

### Endpoint
`/select/from`

### Parameters
#### Request Body
- **from** (string) - Required - The table to select from.

### Response
#### Success Response (200)
- **SelectBuilder** (object) - The SelectBuilder instance with the specified table.
```

--------------------------------

### QueryWith

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Executes a SQL query with a Sqlizer.

```APIDOC
## func QueryWith(db Queryer, s Sqlizer) (rows *sql.Rows, err error)

### Description
Executes a SQL query using a Sqlizer, returning the rows and any error.

### Parameters
* **db** (Queryer) - The database queryer.
* **s** (Sqlizer) - The Sqlizer object representing the SQL query.
```

--------------------------------

### Initialize StatementBuilder

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

This variable is a parent builder for other builders, such as SelectBuilder.

```go
var StatementBuilder = StatementBuilderType(builder.EmptyBuilder).PlaceholderFormat(Question)
```

--------------------------------

### PlaceholderFormat Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

PlaceholderFormat sets the PlaceholderFormat (e.g., Question or Dollar) for the query.

```go
func (b DeleteBuilder) PlaceholderFormat(f PlaceholderFormat) DeleteBuilder
```

--------------------------------

### Build SQL string and args from InsertBuilder

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

ToSql builds the query into a SQL string and bound args. This is useful for debugging or when you need to manually execute the SQL.

```go
func (b InsertBuilder) ToSql() (string, []interface{}, error)
```

--------------------------------

### ExecWith

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Executes a SQL query with a Sqlizer.

```APIDOC
## func ExecWith(db Execer, s Sqlizer) (res sql.Result, err error)

### Description
Executes a SQL statement using a Sqlizer, returning the result and any error.

### Parameters
* **db** (Execer) - The database executor.
* **s** (Sqlizer) - The Sqlizer object representing the SQL statement.
```

--------------------------------

### ExecContextWith

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Executes a SQL query with a context and a Sqlizer.

```APIDOC
## func ExecContextWith(ctx context.Context, db ExecerContext, s Sqlizer) (res sql.Result, err error)

### Description
Executes a SQL statement using a provided context and a Sqlizer, returning the result and any error.

### Parameters
* **ctx** (context.Context) - The context for the query.
* **db** (ExecerContext) - The database executor that supports context.
* **s** (Sqlizer) - The Sqlizer object representing the SQL statement.
```

--------------------------------

### MustSql

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

MustSql builds the query into a SQL string and bound args. It panics if there are any errors.

```APIDOC
## MustSql

### Description
Builds the query into a SQL string and bound arguments. This method panics if any errors occur during the build process.

### Method
func (b SelectBuilder) MustSql() (string, []interface{})
```

--------------------------------

### Generate Placeholders

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Placeholders returns a string with count ? placeholders joined with commas.

```go
func Placeholders(count int) string
```

--------------------------------

### RunWith Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Sets a BaseRunner (like database/sql.DB) to be used with methods like Exec. Useful for mocking database connections in tests.

```go
func (b SelectBuilder) RunWith(runner BaseRunner) SelectBuilder
```

--------------------------------

### Add options to InsertBuilder

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Options adds keyword options before the INTO clause of the query. Use this for options like IGNORE or DELAYED.

```go
func (b InsertBuilder) Options(options ...string) InsertBuilder
```

--------------------------------

### MustSql Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

MustSql builds the query into a SQL string and bound arguments, panicking on error. Added in v1.5.1.

```go
func (b DeleteBuilder) MustSql() (string, []interface{})
```

--------------------------------

### Placeholders

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Generates a string of SQL placeholders.

```APIDOC
## func Placeholders(count int) string

### Description
Generates a string of SQL placeholders, typically used for prepared statements.

### Parameters
* **count** (int) - The number of placeholders to generate.
```

--------------------------------

### UpdateBuilder Exec Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Builds and executes the UPDATE query using the configured Runner.

```go
func (b UpdateBuilder) Exec() (sql.Result, error)
```

--------------------------------

### StmtCache.Exec

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Executes a query using a prepared statement from the cache.

```APIDOC
## StmtCache.Exec

### Description

Exec delegates down to the underlying Preparer using a prepared statement.

### Signature

```go
func (sc *StmtCache) Exec(query string, args ...interface{}) (res sql.Result, err error)
```
```

--------------------------------

### Select Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Returns a SelectBuilder for constructing SELECT statements.

```go
func (b StatementBuilderType) Select(columns ...string) SelectBuilder
```

--------------------------------

### Execute InsertBuilder query

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Exec builds and Execs the query with the Runner set by RunWith. Use this for INSERT statements that do not return rows.

```go
func (b InsertBuilder) Exec() (sql.Result, error)
```

--------------------------------

### Runner Helper Functions

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Functions for creating Runner instances.

```APIDOC
## WrapStdSql(stdSql StdSql)

### Description
Wraps a standard library SQL database connection into a Runner.

### Method
`WrapStdSql(stdSql StdSql)`

### Parameters
- **stdSql** (StdSql) - The standard library SQL database connection.

### Returns
- `Runner`: A Runner instance.
```

```APIDOC
## WrapStdSqlCtx(stdSqlCtx StdSqlCtx)

### Description
Wraps a standard library SQL database connection with context into a RunnerContext.

### Method
`WrapStdSqlCtx(stdSqlCtx StdSqlCtx)`

### Parameters
- **stdSqlCtx** (StdSqlCtx) - The standard library SQL database connection with context.

### Returns
- `RunnerContext`: A RunnerContext instance.
```

--------------------------------

### Limit Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Limit sets a LIMIT clause on the DELETE query.

```go
func (b DeleteBuilder) Limit(limit uint64) DeleteBuilder
```

--------------------------------

### DeleteBuilder.PlaceholderFormat

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Sets the placeholder format for the query.

```APIDOC
## PlaceholderFormat

### Description
PlaceholderFormat sets PlaceholderFormat (e.g. Question or Dollar) for the query.

### Method
func (b DeleteBuilder) PlaceholderFormat(f PlaceholderFormat) DeleteBuilder
```

--------------------------------

### UpdateBuilder MustSql Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Builds the SQL string and arguments for the UPDATE query, panicking if an error occurs.

```go
func (b UpdateBuilder) MustSql() (string, []interface{})
```

--------------------------------

### QueryContextWith

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Executes a SQL query with a context and a Sqlizer.

```APIDOC
## func QueryContextWith(ctx context.Context, db QueryerContext, s Sqlizer) (rows *sql.Rows, err error)

### Description
Executes a SQL query using a provided context and a Sqlizer, returning the rows and any error.

### Parameters
* **ctx** (context.Context) - The context for the query.
* **db** (QueryerContext) - The database queryer that supports context.
* **s** (Sqlizer) - The Sqlizer object representing the SQL query.
```

--------------------------------

### StmtCache.ExecContext

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Executes a query with context using a prepared statement from the cache.

```APIDOC
## StmtCache.ExecContext

### Description

ExecContext delegates down to the underlying PreparerContext using a prepared statement.

### Signature

```go
func (sc *StmtCache) ExecContext(ctx context.Context, query string, args ...interface{}) (res sql.Result, err error)
```
```

--------------------------------

### StmtCache.Exec

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Executes a query and returns the result.

```APIDOC
## StmtCache.Exec

### Description
Executes a query and returns the result.

### Method
POST

### Endpoint
`/stmt_cache/exec`

### Parameters
#### Request Body
- **query** (string) - Required - The SQL query to execute.
- **args** ([]interface{}) - Optional - Arguments for the query.

### Response
#### Success Response (200)
- **sql.Result** (object) - The result of the query execution.
- **error** (error) - An error if the query execution failed.
```

--------------------------------

### StmtCache QueryContext Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Queries the database with context using a prepared statement from the cache, delegating to the underlying PreparerContext.

```go
func (sc *StmtCache) QueryContext(ctx context.Context, query string, args ...interface{}) (rows *sql.Rows, err error)
```

--------------------------------

### ExecContext

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

ExecContext builds and ExecContexts the query with the Runner set by RunWith.

```APIDOC
## ExecContext

### Description
Builds and executes the query with context using the Runner configured by RunWith.

### Method
func (b SelectBuilder) ExecContext(ctx context.Context) (sql.Result, error)
```

--------------------------------

### Options Method Signature

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Defines the signature for the Options method, used to add select options to the query.

```go
func (b SelectBuilder) Options(options ...string) SelectBuilder
```

--------------------------------

### Create New Statement Cacher (Deprecated)

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

NewStmtCacher is deprecated and creates a DBProxyContext. Use NewStmtCache instead.

```go
func NewStmtCacher(prep PreparerContext) DBProxyContext
```

--------------------------------

### Eq.ToSql Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

ToSql converts an Eq map into a SQL string and bound arguments.

```go
func (eq Eq) ToSql() (sql string, args []interface{}, err error)
```

--------------------------------

### Preparer Interface

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Interface for preparing SQL statements.

```APIDOC
## type Preparer

### Description
Prepareer is the interface that wraps the Prepare method. Prepare executes the given query as implemented by database/sql.Prepare.

### Interface Methods
- **Prepare(query string) (*sql.Stmt, error)**: Prepares a SQL statement.
```

--------------------------------

### UpdateBuilder From Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Adds a FROM clause to the UPDATE query. This is valid only in PostgreSQL.

```go
func (b UpdateBuilder) From(from string) UpdateBuilder
```

--------------------------------

### Exec

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Exec builds and Execs the query with the Runner set by RunWith.

```APIDOC
## Exec

### Description
Builds and executes the query using the Runner configured by RunWith.

### Method
func (b SelectBuilder) Exec() (sql.Result, error)
```

--------------------------------

### Like Type Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Method available on the Like type for converting it to SQL.

```APIDOC
## Like.ToSql()

### Description
Compiles the Like expression into a SQL string and its arguments.

### Method
`ToSql()`

### Returns
- `(sql string, args []interface{}, err error)`: The generated SQL string, its arguments, and an error if compilation fails.
```

--------------------------------

### Expr Function

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Builds a Sqlizer expression from a SQL fragment and arguments.

```go
func Expr(sql string, args ...interface{}) Sqlizer
```

--------------------------------

### Generating an INSERT Statement

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Use the Insert function to begin constructing an INSERT query. Specify the table and columns before providing values.

```go
db.Insert("users").Columns("name", "email").Values("John Doe", "john@example.com").ToSql()

```

--------------------------------

### Set Table for Update

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Sets the table to be updated. This is a required step before defining columns or conditions.

```go
func (b UpdateBuilder) Table(table string) UpdateBuilder
```

--------------------------------

### FromSelect Method Signature

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Defines the signature for the FromSelect method, used to set a subquery in the FROM clause.

```go
func (b SelectBuilder) FromSelect(from SelectBuilder, alias string) SelectBuilder
```

--------------------------------

### NotEq Type Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Method available on the NotEq type for converting it to SQL.

```APIDOC
## NotEq.ToSql()

### Description
Compiles the NotEq expression into a SQL string and its arguments.

### Method
`ToSql()`

### Returns
- `(sql string, args []interface{}, err error)`: The generated SQL string, its arguments, and an error if compilation fails.
```

--------------------------------

### Execute SQL with Context using ExecContextWith

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

ExecContextWith executes the SQL returned by s with db.

```go
func ExecContextWith(ctx context.Context, db ExecerContext, s Sqlizer) (res sql.Result, err error)
```

--------------------------------

### Create New Statement Cache Proxy

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

NewStmtCacheProxy creates a new DBProxyBeginner with statement caching.

```go
func NewStmtCacheProxy(db *sql.DB) DBProxyBeginner
```

--------------------------------

### Expr

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Expr builds an expression from a SQL fragment and arguments, returning a Sqlizer.

```APIDOC
## Expr

### Description
Creates a `Sqlizer` object from a raw SQL string and associated arguments. This is useful for constructing complex or dynamic SQL fragments that can be used within other query builder methods.

### Method
Expr

### Endpoint
N/A (Function)

### Parameters
- **sql** (string) - Required - The SQL fragment.
- **args** (...interface{}) - Optional - Arguments to bind to placeholders in the SQL fragment.

### Request Example
```go
customExpr := Expr("FROM_UNIXTIME(?)", 1678886400)
```

### Response
#### Success Response
- **Sqlizer** (Sqlizer) - An object implementing the `Sqlizer` interface.
```

--------------------------------

### Exec Method Signature

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Defines the signature for the Exec method, which builds and executes a query using a pre-configured Runner.

```go
func (b SelectBuilder) Exec() (sql.Result, error)
```

--------------------------------

### DeleteBuilder.RunWith

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Sets the database runner (e.g., sql.DB) to be used for query execution.

```APIDOC
## RunWith

### Description
RunWith sets a Runner (like database/sql.DB) to be used with e.g. Exec.

### Method
func (b DeleteBuilder) RunWith(runner BaseRunner) DeleteBuilder
```

--------------------------------

### Select

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Creates a new SelectBuilder, optionally setting some result columns.

```APIDOC
## func Select

### Description
Select returns a new SelectBuilder, optionally setting some result columns. See SelectBuilder.Columns.

### Signature
```go
func Select(columns ...string) SelectBuilder
```
```

--------------------------------

### Insert Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Returns an InsertBuilder for constructing INSERT statements.

```go
func (b StatementBuilderType) Insert(into string) InsertBuilder
```

--------------------------------

### PlaceholderFormat Method Signature

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Defines the signature for the PlaceholderFormat method, used to set the placeholder format (e.g., Question or Dollar) for the query.

```go
func (b SelectBuilder) PlaceholderFormat(f PlaceholderFormat) SelectBuilder
```

--------------------------------

### Query Method Signature

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Defines the signature for the Query method, which builds and executes a query using a pre-configured Runner.

```go
func (b SelectBuilder) Query() (*sql.Rows, error)
```

--------------------------------

### StmtCache.ExecContext

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Executes a query with context and returns the result.

```APIDOC
## StmtCache.ExecContext

### Description
Executes a query with context and returns the result.

### Method
POST

### Endpoint
`/stmt_cache/exec_context`

### Parameters
#### Query Parameters
- **ctx** (context.Context) - Required - The context for the execution.
#### Request Body
- **query** (string) - Required - The SQL query to execute.
- **args** ([]interface{}) - Optional - Arguments for the query.

### Response
#### Success Response (200)
- **sql.Result** (object) - The result of the query execution.
- **error** (error) - An error if the query execution failed.
```

--------------------------------

### DeleteBuilder.MustSql

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Builds the query into a SQL string and bound arguments, panicking on error.

```APIDOC
## MustSql

### Description
MustSql builds the query into a SQL string and bound args. It panics if there are any errors.

### Method
func (b DeleteBuilder) MustSql() (string, []interface{})
```

--------------------------------

### UpdateBuilder.MustSql

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Returns the generated SQL string and arguments, panicking on error.

```APIDOC
## UpdateBuilder.MustSql

### Description
Returns the generated SQL string and arguments, panicking on error.

### Method
GET

### Endpoint
`/update/must_sql`

### Response
#### Success Response (200)
- **string** (string) - The generated SQL query.
- **[]interface{}** ([]interface{}) - The arguments for the SQL query.
```

--------------------------------

### SelectBuilder.Columns

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Specifies the columns to select.

```APIDOC
## SelectBuilder.Columns

### Description
Specifies the columns to select.

### Method
POST

### Endpoint
`/select/columns`

### Parameters
#### Request Body
- **columns** ([]string) - Required - The columns to select.

### Response
#### Success Response (200)
- **SelectBuilder** (object) - The SelectBuilder instance with the specified columns.
```

--------------------------------

### Prefix Method Signature

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Defines the signature for the Prefix method, used to add an expression to the beginning of the query.

```go
func (b SelectBuilder) Prefix(sql string, args ...interface{}) SelectBuilder
```

--------------------------------

### SelectBuilder.ToSql

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

ToSql builds the query into a SQL string and its corresponding bound arguments. It returns the SQL string, arguments, and any potential error.

```APIDOC
## SelectBuilder.ToSql

### Description
Compiles the constructed query into a raw SQL string and a slice of arguments ready to be used with a database driver (e.g., `database/sql`).

### Method
SelectBuilder

### Endpoint
N/A (Method on SelectBuilder object)

### Parameters
None

### Request Example
```go
sql, args, err := sb.ToSql()
if err != nil {
    // Handle error
}
fmt.Println(sql, args)
```

### Response
#### Success Response
- **string** - The generated SQL query string.
- **[]interface{}** - A slice of arguments to be bound to the SQL query.
- **error** - nil if the compilation is successful.
```

--------------------------------

### StmtCache.PrepareContext

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Prepares and caches a SQL statement with context.

```APIDOC
## StmtCache.PrepareContext

### Description

PrepareContext delegates down to the underlying PreparerContext and caches the result using the provided query as a key.

### Signature

```go
func (sc *StmtCache) PrepareContext(ctx context.Context, query string) (*sql.Stmt, error)
```
```

--------------------------------

### StmtCache.NewStmtCache

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Creates a new StmtCache with the given preparer.

```APIDOC
## NewStmtCache

### Description
Creates a new StmtCache with the given preparer.

### Method
POST

### Endpoint
`/stmt_cache/new`

### Parameters
#### Request Body
- **prep** (PreparerContext) - Required - The preparer context.

### Response
#### Success Response (200)
- **StmtCache** (object) - A pointer to the newly created StmtCache.
```

--------------------------------

### StmtCache Query Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Queries the database using a prepared statement from the cache, delegating to the underlying Preparer.

```go
func (sc *StmtCache) Query(query string, args ...interface{}) (rows *sql.Rows, err error)
```

--------------------------------

### QueryRowContext Method Signature

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Defines the signature for the QueryRowContext method, which builds and executes a query to return a single row with context using a pre-configured Runner.

```go
func (b SelectBuilder) QueryRowContext(ctx context.Context) RowScanner
```

--------------------------------

### Define DBProxy Interface

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

DBProxy groups the Execer, Queryer, QueryRower, and Preparer interfaces.

```go
type DBProxy interface {
	Execer
	Queryer
	QueryRower
	Preparer
}
```

--------------------------------

### ExecerContext Interface

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

ExecerContext is the interface that wraps the ExecContext method, used by database/sql.ExecContext.

```go
type ExecerContext interface {
	ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error)
}
```

--------------------------------

### StmtCache.Prepare

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Prepares and caches a SQL statement.

```APIDOC
## StmtCache.Prepare

### Description

Prepare delegates down to the underlying Preparer and caches the result using the provided query as a key.

### Signature

```go
func (sc *StmtCache) Prepare(query string) (*sql.Stmt, error)
```
```

--------------------------------

### Or ToSql Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

The ToSql method for the Or type returns the SQL string and arguments for an OR conjunction.

```go
func (o Or) ToSql() (string, []interface{}, error)
```

--------------------------------

### NewStmtCache Function

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Creates a new StmtCache that caches prepared statements based on their query strings.

```go
func NewStmtCache(prep PreparerContext) *StmtCache
```

--------------------------------

### ExecContext Method Signature

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Defines the signature for the ExecContext method, which builds and executes a query with context using a pre-configured Runner.

```go
func (b SelectBuilder) ExecContext(ctx context.Context) (sql.Result, error)
```

--------------------------------

### UpdateBuilder.ToSql

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Returns the generated SQL string and arguments.

```APIDOC
## UpdateBuilder.ToSql

### Description
Returns the generated SQL string and arguments.

### Method
GET

### Endpoint
`/update/to_sql`

### Response
#### Success Response (200)
- **string** (string) - The generated SQL query.
- **[]interface{}** ([]interface{}) - The arguments for the SQL query.
- **error** (error) - An error if the SQL generation failed.
```

--------------------------------

### Build SQL String with MustSql for CaseBuilder

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

MustSql builds the query into a SQL string and bound args. It panics if there are any errors. Added in v1.5.1.

```go
func (b CaseBuilder) MustSql() (string, []interface{})
```

--------------------------------

### NewStmtCache

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Creates a new StmtCache that caches prepared statements.

```APIDOC
## NewStmtCache

### Description

NewStmtCache returns a *StmtCache wrapping a PreparerContext that caches Prepared Stmts. Stmts are cached based on the string value of their queries.

### Signature

```go
func NewStmtCache(prep PreparerContext) *StmtCache
```
```

--------------------------------

### Query Rows with Context

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Executes the query with a given context and returns sql.Rows. Preferred for operations needing cancellation or timeouts.

```go
func (b UpdateBuilder) QueryContext(ctx context.Context) (*sql.Rows, error)
```

--------------------------------

### UpdateBuilder.Exec

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Builds and executes the UPDATE query.

```APIDOC
## UpdateBuilder.Exec

### Description

Exec builds and Execs the query with the Runner set by RunWith.

### Signature

```go
func (b UpdateBuilder) Exec() (sql.Result, error)
```
```

--------------------------------

### NewStmtCacheProxy

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

NewStmtCacheProxy creates a new DBProxyBeginner with statement caching enabled.

```APIDOC
## NewStmtCacheProxy

### Description
NewStmtCacheProxy creates a new DBProxyBeginner with statement caching enabled.

### Method Signature
```go
func NewStmtCacheProxy(db *sql.DB) DBProxyBeginner
```
```

--------------------------------

### Define DBProxyContext Interface

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

DBProxyContext groups the Execer, Queryer, QueryRower and PreparerContext interfaces.

```go
type DBProxyContext interface {
	Execer
	Queryer
	QueryRower
	PreparerContext
}
```

--------------------------------

### SelectBuilder.RunWith

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Configures the select builder to use a specific runner for query execution.

```APIDOC
## SelectBuilder.RunWith

### Description
Configures the select builder to use a specific runner for query execution.

### Method
POST

### Endpoint
`/select/run_with`

### Parameters
#### Request Body
- **runner** (BaseRunner) - Required - The runner to use for query execution.

### Response
#### Success Response (200)
- **SelectBuilder** (object) - The SelectBuilder instance configured with the specified runner.
```

--------------------------------

### QueryContext

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

QueryContext builds and QueryContexts the query with the Runner set by RunWith.

```APIDOC
## QueryContext

### Description
Builds and executes the query with context using the Runner configured by RunWith, returning rows.

### Method
func (b SelectBuilder) QueryContext(ctx context.Context) (*sql.Rows, error)
```

--------------------------------

### QueryRowContext

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

QueryRowContext builds and QueryRowContexts the query with the Runner set by RunWith.

```APIDOC
## QueryRowContext

### Description
Builds and executes the query with context using the Runner configured by RunWith, returning a single row scanner.

### Method
func (b SelectBuilder) QueryRowContext(ctx context.Context) RowScanner
```

--------------------------------

### UpdateBuilder.MustSql

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Builds the UPDATE query into SQL and arguments, panicking on error.

```APIDOC
## UpdateBuilder.MustSql

### Description

MustSql builds and Execs the query with the Runner set by RunWith.

### Signature

```go
func (b UpdateBuilder) MustSql() (string, []interface{})
```
```

--------------------------------

### QueryRow Method Signature

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Defines the signature for the QueryRow method, which builds and executes a query to return a single row using a pre-configured Runner.

```go
func (b SelectBuilder) QueryRow() RowScanner
```

--------------------------------

### Case Builder

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Builds a SQL CASE statement.

```APIDOC
## func Case(what ...interface{}) CaseBuilder

### Description
Starts building a SQL CASE statement.

### Parameters
* **what** (...interface{}) - Optional initial expression for the CASE statement.
```

```APIDOC
## func (b CaseBuilder) Else(expr interface{}) CaseBuilder

### Description
Adds an ELSE clause to the CASE statement.

### Parameters
* **expr** (interface{}) - The expression for the ELSE clause.
```

```APIDOC
## func (b CaseBuilder) MustSql() (string, []interface{})

### Description
Returns the generated SQL string and arguments, panicking if an error occurs.
```

```APIDOC
## func (b CaseBuilder) ToSql() (string, []interface{}, error)

### Description
Returns the generated SQL string and arguments, or an error if generation fails.

### Returns
A tuple containing the SQL string, arguments, and an error.
```

```APIDOC
## func (b CaseBuilder) When(when interface{}, then interface{}) CaseBuilder

### Description
Adds a WHEN clause to the CASE statement.

### Parameters
* **when** (interface{}) - The condition for the WHEN clause.
* **then** (interface{}) - The expression to return when the condition is met.
```

--------------------------------

### Runner Interface

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Groups the Execer, Queryer, and QueryRower interfaces.

```APIDOC
## type Runner

### Description
Runner groups the Execer, Queryer, and QueryRower interfaces.

### Interface Methods
- **Execer**: Interface for executing statements that do not return rows.
- **Queryer**: Interface for executing queries that return multiple rows.
- **QueryRower**: Interface for executing queries that return a single row.
```

--------------------------------

### UpdateBuilder ExecContext Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Builds and executes the UPDATE query with context using the configured Runner.

```go
func (b UpdateBuilder) ExecContext(ctx context.Context) (sql.Result, error)
```

--------------------------------

### NotEq Type and ToSql Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

NotEq is syntactic sugar for use with Where/Having/Set methods, representing not equal conditions.

```APIDOC
## type NotEq

### Description
NotEq is syntactic sugar for use with Where/Having/Set methods. Ex: 
```
.Where(NotEq{"id": 1}) == "id <> 1"
```

## func (NotEq) ToSql

### Description
Converts a NotEq condition into its SQL string representation and arguments.

### Signature
```go
func (neq NotEq) ToSql() (sql string, args []interface{}, err error)
```
```

--------------------------------

### RunWith Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

RunWith sets a BaseRunner (like database/sql.DB) to be used with execution methods.

```go
func (b DeleteBuilder) RunWith(runner BaseRunner) DeleteBuilder
```

--------------------------------

### Runner Interface

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

The Runner interface groups Execer, Queryer, and QueryRower for combined database operations.

```go
type Runner interface {
	Execer
	Queryer
	QueryRower
}
```

--------------------------------

### Set Multiple Columns for Update

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

A convenience method that calls .Set for each key/value pair in the provided map. Useful for updating multiple columns at once.

```go
func (b UpdateBuilder) SetMap(clauses map[string]interface{}) UpdateBuilder
```

--------------------------------

### From

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

From sets the FROM clause of the query.

```APIDOC
## From

### Description
Sets the FROM clause of the SQL query.

### Method
func (b SelectBuilder) From(from string) SelectBuilder
```

--------------------------------

### Query SQL with Context using QueryContextWith

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

QueryContextWith queries the SQL returned by s with db.

```go
func QueryContextWith(ctx context.Context, db QueryerContext, s Sqlizer) (rows *sql.Rows, err error)
```

--------------------------------

### Execute InsertBuilder query with context

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

ExecContext builds and ExecContexts the query with the Runner set by RunWith. This version accepts a context.Context for cancellation and timeouts.

```go
func (b InsertBuilder) ExecContext(ctx context.Context) (sql.Result, error)
```

--------------------------------

### Update Function

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Initializes a new UpdateBuilder for a specified table.

```go
func Update(table string) UpdateBuilder
```

--------------------------------

### Sqlizer Interface

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Interface for SQL representations that can return a SQL string and arguments. Used for custom SQL expressions.

```go
type Sqlizer interface {
	ToSql() (string, []interface{}, error)
}
```

--------------------------------

### Replace Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Returns an InsertBuilder for constructing REPLACE statements.

```go
func (b StatementBuilderType) Replace(into string) InsertBuilder
```

--------------------------------

### QueryRowerContext Interface

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

The QueryRowerContext interface extends QueryRower with a context-aware QueryRowContext method.

```go
type QueryRowerContext interface {
	QueryRowContext(ctx context.Context, query string, args ...interface{}) RowScanner
}
```

--------------------------------

### Query

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Query builds and Querys the query with the Runner set by RunWith.

```APIDOC
## Query

### Description
Builds and executes the query using the Runner configured by RunWith, returning rows.

### Method
func (b SelectBuilder) Query() (*sql.Rows, error)
```

--------------------------------

### DeleteBuilder.ExecContext

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Builds and executes the DELETE query using the provided context and runner.

```APIDOC
## ExecContext

### Description
Builds and ExecContexts the query with the Runner set by RunWith.

### Method
func (b DeleteBuilder) ExecContext(ctx context.Context) (sql.Result, error)
```

--------------------------------

### ExecWith

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

ExecWith executes the SQL returned by a Sqlizer with a given Execer.

```APIDOC
## ExecWith

### Description
ExecWith Execs the SQL returned by s with db.

### Method Signature
```go
func ExecWith(db Execer, s Sqlizer) (res sql.Result, err error)
```
```

--------------------------------

### QueryContext Method Signature

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Defines the signature for the QueryContext method, which builds and executes a query with context using a pre-configured Runner.

```go
func (b SelectBuilder) QueryContext(ctx context.Context) (*sql.Rows, error)
```

--------------------------------

### Execute a Query with Database Connection

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Run a constructed query against a database. Squirrel's RunWith method allows execution using a provided database connection, behaving similarly to a standard DB.Query call.

```go
stooges := users.Where(sq.Eq{"username": []string{"moe", "larry", "curly", "shemp"}})
three_stooges := stooges.Limit(3)
rows, err := three_stooges.RunWith(db).Query()

// Behaves like:
rows, err := db.Query("SELECT * FROM users WHERE username IN (?,?,?,?) LIMIT 3",
                      "moe", "larry", "curly", "shemp")

```

--------------------------------

### CaseBuilder.ToSql

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

ToSql builds the query into a SQL string and bound arguments.

```APIDOC
## CaseBuilder.ToSql

### Description
ToSql builds the query into a SQL string and bound args.

### Method Signature
```go
func (b CaseBuilder) ToSql() (string, []interface{}, error)
```
```

--------------------------------

### Set Runner for Query Execution

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Sets a Runner (like database/sql.DB) to be used with execution methods like Exec or Query.

```go
func (b UpdateBuilder) RunWith(runner BaseRunner) UpdateBuilder
```

--------------------------------

### DeleteBuilder.Prefix

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Adds a SQL expression to the beginning of the query.

```APIDOC
## Prefix

### Description
Prefix adds an expression to the beginning of the query

### Method
func (b DeleteBuilder) Prefix(sql string, args ...interface{}) DeleteBuilder
```

--------------------------------

### ExecContextWith

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

ExecContextWith executes the SQL returned by a Sqlizer with a given ExecerContext.

```APIDOC
## ExecContextWith

### Description
ExecContextWith ExecContexts the SQL returned by s with db.

### Method Signature
```go
func ExecContextWith(ctx context.Context, db ExecerContext, s Sqlizer) (res sql.Result, err error)
```
```

--------------------------------

### Like.ToSql

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Converts a Like condition into its SQL string representation and arguments.

```APIDOC
## func (Like) ToSql

### Description
Converts a Like condition into its SQL string representation and arguments.

### Signature
```go
func (lk Like) ToSql() (sql string, args []interface{}, err error)
```
```

--------------------------------

### StatementBuilderType.Select

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Initiates the construction of a SELECT statement with the specified columns.

```APIDOC
## Select

### Description
Initiates the construction of a SELECT statement with the specified columns.

### Method
GET

### Endpoint
`/select`

### Parameters
#### Query Parameters
- **columns** (string) - Required - Comma-separated list of columns to select.

### Response
#### Success Response (200)
- **SelectBuilder** (object) - A SelectBuilder instance to continue building the query.
```

--------------------------------

### Lt Type Method

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

Method available on the Lt type for converting it to SQL.

```APIDOC
## Lt.ToSql()

### Description
Compiles the Lt expression into a SQL string and its arguments.

### Method
`ToSql()`

### Returns
- `(sql string, args []interface{}, err error)`: The generated SQL string, its arguments, and an error if compilation fails.
```

--------------------------------

### SelectBuilder.RunWith

Source: https://pkg.go.dev/github.com/Masterminds/squirrel

RunWith sets a BaseRunner (like database/sql.DB) to be used with methods like Exec. This is useful for mocking database connections in tests.

```APIDOC
## SelectBuilder.RunWith

### Description
Sets a `BaseRunner` (e.g., `database/sql.DB`) that will be used for executing the query. This is particularly useful for dependency injection and mocking database connections during testing.

### Method
SelectBuilder

### Endpoint
N/A (Method on SelectBuilder object)

### Parameters
- **runner** (BaseRunner) - Required - The database runner to be used for query execution.

### Request Example
```go
// Assuming 'sb' is a SelectBuilder instance and 'db' is a *sql.DB
newSb := sb.RunWith(db)
```

### Response
#### Success Response
- **SelectBuilder** (SelectBuilder) - The modified SelectBuilder with the specified runner set.
```
Tokens:
Raw