Fluxa ORM

https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2
Admin
Fluxa ORM is a high-performance Golang ORM designed for MySQL with integrated Redis caching, Redis...
Tokens:36,933
Snippets:292
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Initialize New Registry

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Creates and returns a new instance of the Registry interface. Use this to start configuring database connections and other services.

```go
func NewRegistry() Registry
```

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

### Get Assembled Redis Search Query String

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Returns the complete query string, with conditions joined by spaces (AND). Returns '*' if the query is empty.

```go
func (w *RedisSearchWhere) String() string
```

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

### Get Kafka Records from Fetches

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Records returns a slice of KafkaRecord pointers from the fetches.

```go
func (f KafkaFetches) Records() []*KafkaRecord
```

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

### Create New BaseWhere Instance

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

NewWhere creates a new BaseWhere instance with an initial query string and optional parameters. Use this to start building a WHERE clause.

```go
func NewWhere(query string, parameters ...any) *BaseWhere
```

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

### Get Redis Search Options with Limit and Sort

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Returns redis.FTSearchOptions including NOCONTENT, LIMIT offset/count, and optional SORTBY.

```go
func (w *RedisSearchWhere) GetSearchOptions(offset, count int) *redis.FTSearchOptions
```

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

### Get Database Alters

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Retrieves a list of pending ALTER statements for the database.

```go
func GetAlters(ctx Context) (alters []Alter, err error)
```

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

### Redis Pipeline Get Method

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Retrieves a value from Redis by key within a pipeline. Returns a PipeLineGet for chaining.

```go
func (rp *RedisPipeLine) Get(key string) *PipeLineGet
```

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

### GET /redis/search/alters

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Retrieves pending FT.CREATE operations for entities with Redis Search enabled.

```APIDOC
## GET /redis/search/alters

### Description
Returns pending FT.CREATE operations for all entities with Redis Search enabled. Only indexes that do not yet exist are returned.

### Method
GET

### Endpoint
/redis/search/alters

### Response
#### Success Response (200)
- **alters** (array) - List of RedisSearchAlter objects

#### Response Example
[
  {
    "IndexName": "my_index",
    "RedisPool": "default"
  }
]
```

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

### PipeLineGet

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Represents a pipeline for retrieving a string value, providing a Result method to get the value and its existence.

```APIDOC
## PipeLineGet

### Description
Represents a pipeline for retrieving a string value, providing a Result method to get the value and its existence.

### Type Definition
```go
type PipeLineGet struct {
	// contains filtered or unexported fields
}
```

### Methods
#### Result
Executes the pipeline and returns the string value, a boolean indicating its presence, and any error encountered.
```go
func (c *PipeLineGet) Result() (value string, has bool, err error)
```
```

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

### Get Database Alters

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Retrieves pending schema alterations from the current context.

```APIDOC
## GetAlters

### Description
Retrieves a list of pending SQL alterations.

### Parameters
- **ctx** (Context) - Required

### Response
- **alters** ([]Alter) - List of pending alterations.
- **err** (error) - Error if retrieval fails.
```

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

### Get String Representation of BaseWhere

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

String returns the SQL WHERE clause as a string. This method is useful for inspecting the generated query.

```go
func (w *BaseWhere) String() string
```

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

### Get pending Kafka operations

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

GetKafkaAlters compares registered Kafka topic definitions with actual broker state and returns the operations needed to synchronize them. Requires a Context.

```go
func GetKafkaAlters(ctx Context) ([]KafkaAlter, error)
```

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

### Get Redis Search Alters Function

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Retrieves pending FT.CREATE operations for entities with Redis Search enabled. Only returns indexes that do not yet exist.

```go
func GetRedisSearchAlters(ctx Context) ([]RedisSearchAlter, error)
```

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

### Prepare Tables for Testing

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Utility functions to initialize database tables for testing, optionally with Kafka or Debezium support.

```go
func PrepareTables(t *testing.T, registry Registry, entities ...any) (orm Context)
```

```go
func PrepareTablesWithDebezium(t *testing.T, registry Registry, entities ...any) (orm Context)
```

```go
func PrepareTablesWithKafka(t *testing.T, registry Registry, entities ...any) (orm Context)
```

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

### Define Database Configuration Structs

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Configuration structures for MySQL and Redis database connections.

```go
type ConfigMysql struct {
	Code               string   `yaml:"code" validate:"required"`
	URI                string   `yaml:"uri" validate:"required"`
	ConnMaxLifetime    int      `yaml:"connMaxLifetime"`
	MaxOpenConnections int      `yaml:"maxOpenConnections"`
	MaxIdleConnections int      `yaml:"maxIdleConnections"`
	DefaultEncoding    string   `yaml:"defaultEncoding"`
	DefaultCollate     string   `yaml:"defaultCollate"`
	IgnoredTables      []string `yaml:"ignoredTables"`
}
```

```go
type ConfigRedis struct {
	Code     string `yaml:"code" validate:"required"`
	URI      string `yaml:"uri" validate:"required"`
	Database int    `yaml:"database"`
	User     string `yaml:"user"`
	Password string `yaml:"password"`
}
```

```go
type ConfigRedisSentinel struct {
	Code       string   `yaml:"code" validate:"required"`
	MasterName string   `yaml:"masterName" validate:"required"`
	Database   int      `yaml:"database"`
	Sentinels  []string `yaml:"sentinels"`
	User       string   `yaml:"user"`
	Password   string   `yaml:"password"`
}
```

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

### RedisSearchQuery Builder Methods

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Methods for constructing and configuring Redis FT.SEARCH queries.

```go
type RedisSearchQuery struct {
	// contains filtered or unexported fields
}
```

```go
func NewRedisSearchQuery() *RedisSearchQuery
```

```go
func (q *RedisSearchQuery) BuildQueryString() string
```

```go
func (q *RedisSearchQuery) BuildSearchOptions(offset, count int) *redis.FTSearchOptions
```

```go
func (q *RedisSearchQuery) Filter(conditions ...RedisSearchCondition) *RedisSearchQuery
```

```go
func (q *RedisSearchQuery) GetPagerOffsetCount() (offset int, count int)
```

```go
func (q *RedisSearchQuery) Pager(p *Pager) *RedisSearchQuery
```

```go
func (q *RedisSearchQuery) SortByASC(f RedisSearchField) *RedisSearchQuery
```

```go
func (q *RedisSearchQuery) SortByDESC(f RedisSearchField) *RedisSearchQuery
```

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

### Define Kafka and Cache Configuration Structs

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Configuration structures for Kafka consumer groups, topics, and local cache settings.

```go
type ConfigKafkaConsumerGroup struct {
	Name                 string   `yaml:"name" validate:"required"`
	Topics               []string `yaml:"topics" validate:"required"`
	SessionTimeoutMs     int      `yaml:"sessionTimeoutMs"`
	RebalanceTimeoutMs   int      `yaml:"rebalanceTimeoutMs"`
	FetchMaxBytes        int      `yaml:"fetchMaxBytes"`
	AutoCommitIntervalMs int      `yaml:"autoCommitIntervalMs"`
}
```

```go
type ConfigKafkaTopic struct {
	Name              string            `yaml:"name" validate:"required"`
	Partitions        int32             `yaml:"partitions"`
	ReplicationFactor int16             `yaml:"replicationFactor"`
	Configs           map[string]string `yaml:"configs"`
}
```

```go
type ConfigLocalCache struct {
	Code  string `yaml:"code" validate:"required"`
	Limit int    `yaml:"limit" validate:"required"`
}
```

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

### Get Column Name for ReferenceField

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Returns the column name for a ReferenceField. This is a method on the ReferenceField type.

```go
func (f ReferenceField) ColumnName() string
```

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

### Initialize Redis Search Where Builder

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Creates a new, empty builder for constructing FT.SEARCH query strings.

```go
func NewRedisSearchWhere() *RedisSearchWhere
```

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

### PipeLineBool

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Represents a pipeline for boolean operations, providing a Result method to get the boolean outcome.

```APIDOC
## PipeLineBool

### Description
Represents a pipeline for boolean operations, providing a Result method to get the boolean outcome.

### Type Definition
```go
type PipeLineBool struct {
	// contains filtered or unexported fields
}
```

### Methods
#### Result
Executes the pipeline and returns the boolean result and any error encountered.
```go
func (c *PipeLineBool) Result() (bool, error)
```
```

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

### Get Column Name for UintField

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Returns the name of the column represented by a UintField. This is a standard accessor method.

```go
func (f UintField) ColumnName() string
```

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

### Define Async SQL Topic Names

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Constants for naming asynchronous SQL and dead-letter topics.

```go
const (
	AsyncSQLTopicName           = "_fluxa_async_sql"
	AsyncSQLDeadLetterTopicName = "_fluxa_async_sql_failed"
)
```

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

### Get Column Name for TimeField

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Retrieves the column name for a TimeField. This is a common method for all field types.

```go
func (f TimeField) ColumnName() string
```

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

### POST /redis/search/alters/exec

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Executes a pending FT.CREATE command for a specific Redis search index.

```APIDOC
## POST /redis/search/alters/exec

### Description
Executes the FT.CREATE command for the specified RedisSearchAlter configuration.

### Method
POST

### Endpoint
/redis/search/alters/exec

### Request Body
- **IndexName** (string) - Required - The name of the index to create
- **RedisPool** (string) - Required - The pool identifier

### Response
#### Success Response (200)
- **status** (string) - Success confirmation
```

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

### Get Redis Search Field Column Name

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Retrieves the column name for a RedisSearchUintField. Added in v2.2.2.

```go
func (f RedisSearchUintField) ColumnName() string
```

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

### Get Column Name for StringField

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Returns the column name associated with a StringField. This is a standard method for field types.

```go
func (f StringField) ColumnName() string
```

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

### Configure QueryLoggerOptions

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Defines which data sources should be logged by the query logger.

```go
type QueryLoggerOptions struct {
	MySQL      bool
	Redis      bool
	Local      bool
	Clickhouse bool
	Kafka      bool
}
```

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

### EngineRegistry Interface

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Provides access to pools of various database and cache connections.

```go
type EngineRegistry interface {
	DBPools() map[string]DB
	ClickhousePools() map[string]Clickhouse
	KafkaPools() map[string]Kafka
	LocalCachePools() map[string]LocalCache
	RedisPools() map[string]RedisCache
	Option(key string) any
	// contains filtered or unexported methods
}
```

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

### MockDBClient

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Mock implementation of database clients for unit testing.

```APIDOC
## MockDBClient

### Description
Allows overriding database operations with custom mock functions for testing database interactions.

### Methods
- **Exec(query, args)**: Mock execution of SQL commands.
- **ExecContext(context, query, args)**: Mock execution with context.
- **Query(query, args)**: Mock SQL query execution.
```

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

### Get Column Name for BoolField

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

ColumnName returns the name of the boolean column represented by the BoolField. This is part of the Field interface.

```go
func (f BoolField) ColumnName() string
```

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

### Async Flush Options

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Options for asynchronous flushing. Added in v2.2.0.

```go
type AsyncFlushOptions struct {
	TopicPartitions int32 // default: 1
}
```

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

### Entity Interface

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Defines the lifecycle and metadata methods for database entities.

```go
type Entity interface {
	PrivateFlush() error
	PrivateFlushed()
	PrivateFlushEvent() (uint8, map[string]any)
	PrivateGetDatabaseBind() map[string]any
	GetID() uint64
}
```

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

### Get Parameters from BaseWhere

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

GetParameters retrieves all parameters associated with the BaseWhere instance. This is useful for debugging or manual query construction.

```go
func (w *BaseWhere) GetParameters() []any
```

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

### Registry Interface

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

The Registry interface provides methods to configure and initialize database engines, caches, and message brokers like MySQL, Redis, Clickhouse, and Kafka.

```APIDOC
## Registry Interface

### Description
The Registry interface is used to register various infrastructure components such as databases, caches, and message queues, and to initialize the ORM engine.

### Methods
- **Validate() (Engine, error)** - Validates the configuration and returns the ORM Engine.
- **RegisterMySQL(dataSourceName string, poolCode string, poolOptions *MySQLOptions)** - Registers a MySQL database connection.
- **RegisterRedis(address string, db int, poolCode string, options *RedisOptions)** - Registers a Redis cache connection.
- **RegisterKafka(brokers []string, poolCode string, options *KafkaPoolOptions)** - Registers a Kafka message broker.
- **InitByYaml(yaml any) error** - Initializes the registry using a YAML configuration.
- **InitByConfig(config *Config) error** - Initializes the registry using a configuration object.
```

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

### Redis Pool Config Interface

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Interface for Redis pool configuration, providing methods to get code, database number, and address.

```go
type RedisPoolConfig interface {
	GetCode() string
	GetDatabaseNumber() int
	GetAddress() string
	// contains filtered or unexported methods
}
```

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

### Pager Utility Methods

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Provides pagination logic for database queries.

```go
type Pager struct {
	CurrentPage int
	PageSize    int
}
```

```go
func NewPager(currentPage, pageSize int) *Pager
```

```go
func (pager *Pager) GetCurrentPage() int
```

```go
func (pager *Pager) GetPageSize() int
```

```go
func (pager *Pager) IncrementPage()
```

```go
func (pager *Pager) String() string
```

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

### Entity Index and Provider Interfaces

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Interfaces for defining entity indexes and provider metadata.

```go
type EntityCachedUniqueIndexes interface {
	CachedUniqueIndexes() [][]string
}
```

```go
type EntityIndexes interface {
	Indexes() [][]string
}
```

```go
type EntityProvider interface {
	TableName() string
	DBCode() string
}
```

```go
type EntityUniqueIndexes interface {
	UniqueIndexes() [][]string
}
```

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

### Use DBQuery Builder

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Type-safe query builder for MySQL queries.

```go
type DBQuery struct {
	// contains filtered or unexported fields
}
```

```go
func NewQuery() *DBQuery
```

```go
func (q *DBQuery) BuildLimitClause() string
```

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

### Redis Search Field Interface

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Implemented by all Redis Search field types, providing a method to get the column name. Added in v2.2.1.

```go
type RedisSearchField interface {
	ColumnName() string
}
```

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

### Redis Options Struct

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Defines connection options for Redis, including user, password, master, sentinels, and sentinel options.

```go
type RedisOptions struct {
	User            string
	Password        string
	Master          string
	Sentinels       []string
	SentinelOptions *redis.FailoverOptions
}
```

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

### Redis Search Alter Exec Method

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Executes the FT.CREATE command for a pending Redis Search alteration.

```go
func (a RedisSearchAlter) Exec(ctx Context) error
```

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

### Where Interface Definition

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Defines an interface for representing WHERE clauses in SQL queries. It includes methods to get the string representation, parameters, and check for fake deletes.

```go
type Where interface {
	String() string
	GetParameters() []any
	IsWithFakeDeletes() bool
}
```

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

### Helper Functions

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Utility functions for preparing tables for testing.

```APIDOC
## Helper Functions

### PrepareTables
`func PrepareTables(t *testing.T, registry Registry, entities ...any) (orm Context)`
Prepares tables for testing using the provided entities.

### PrepareTablesWithDebezium
`func PrepareTablesWithDebezium(t *testing.T, registry Registry, entities ...any) (orm Context)`
Prepares tables for testing with Debezium integration.

### PrepareTablesWithKafka
`func PrepareTablesWithKafka(t *testing.T, registry Registry, entities ...any) (orm Context)`
Prepares tables for testing with Kafka integration.
```

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

### Async SQL Consumer Interface

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Interface for consuming asynchronous SQL events from Kafka and executing them against MySQL.

```go
type AsyncSQLConsumer interface {
	Consume(count int, blockTime time.Duration) error
	Close()
}
```

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

### RedisSearchIntField Comparison Methods

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Comparison operations for integer fields in Redis Search.

```go
func (f RedisSearchIntField) Eq(v int64) RedisSearchCondition
```

```go
func (f RedisSearchIntField) Gt(v int64) RedisSearchCondition
```

```go
func (f RedisSearchIntField) Gte(v int64) RedisSearchCondition
```

```go
func (f RedisSearchIntField) Lt(v int64) RedisSearchCondition
```

```go
func (f RedisSearchIntField) Lte(v int64) RedisSearchCondition
```

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

### Kafka Consumer Group Interface

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

The KafkaConsumerGroup interface defines the essential methods for interacting with a Kafka consumer group, including fetching data and committing offsets. It requires methods for getting name, settings, Kgo client, polling fetches, and committing offsets.

```go
type KafkaConsumerGroup interface {
	GetName() string
	GetSettings() *KafkaConsumerGroupSettings
	GetKgoClient() *kgo.Client
	PollFetches(ctx Context) KafkaFetches
	CommitUncommittedOffsets(ctx Context) error
	Close()
}
```

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

### MockDBClient Methods

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Methods for mocking database queries in a testing environment.

```APIDOC
## QueryContext

### Description
Executes a query with context.

### Method
QueryContext(context context.Context, query string, args ...any) (*sql.Rows, error)

## QueryRow

### Description
Executes a query that returns a single row.

### Method
QueryRow(query string, args ...any) *sql.Row

## QueryRowContext

### Description
Executes a query that returns a single row with context.

### Method
QueryRowContext(context context.Context, query string, args ...any) *sql.Row
```

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

### Redis Search Query Builder

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Methods for constructing and configuring Redis search queries.

```go
func NewRedisSearchQuery() *RedisSearchQuery
func (q *RedisSearchQuery) BuildQueryString() string
func (q *RedisSearchQuery) BuildSearchOptions(offset, count int) *redis.FTSearchOptions
func (q *RedisSearchQuery) Filter(conditions ...RedisSearchCondition) *RedisSearchQuery
func (q *RedisSearchQuery) GetPagerOffsetCount() (offset int, count int)
func (q *RedisSearchQuery) Pager(p *Pager) *RedisSearchQuery
func (q *RedisSearchQuery) SortByASC(f RedisSearchField) *RedisSearchQuery
func (q *RedisSearchQuery) SortByDESC(f RedisSearchField) *RedisSearchQuery
```

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

### Define PipeLineString Structure

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Represents a pipeline that returns a string.

```go
type PipeLineString struct {
	// contains filtered or unexported fields
}
```

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

### Engine Interface

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Defines the primary engine interface for managing database connections and contexts.

```go
type Engine interface {
	NewContext(parent context.Context) Context
	DB(code string) DB
	Clickhouse(code string) Clickhouse
	Kafka(code string) Kafka
	LocalCache(code string) LocalCache
	Redis(code string) RedisCache
	Registry() EngineRegistry
	Option(key string) any
}
```

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

### MockDBClient QueryRowContext

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Provides a mock implementation for querying a single row from a database context.

```APIDOC
## MockDBClient QueryRowContext

### Description
This method mocks the behavior of querying a single row from a database using a given context and query.

### Method
*Mock*

### Endpoint
N/A (In-memory mock)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```go
// Example usage (conceptual)
ctx := context.Background()
query := "SELECT * FROM users WHERE id = ?"
row := mockDBClient.QueryRowContext(ctx, query, 1)
```

### Response
#### Success Response (Mocked)
Returns a *sql.Row object that can be used to scan data.

#### Response Example
```go
// Conceptual response handling
var name string
err := row.Scan(&name)
```
```

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

### QueryLoggerOptions

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Options for configuring the query logger.

```APIDOC
## QueryLoggerOptions

### Description
Options for configuring the query logger. Added in v2.1.3.

### Fields
- **MySQL** (bool) - Whether to log MySQL queries.
- **Redis** (bool) - Whether to log Redis queries.
- **Local** (bool) - Whether to log local queries.
- **Clickhouse** (bool) - Whether to log Clickhouse queries.
- **Kafka** (bool) - Whether to log Kafka queries.

### Usage Example
```json
{
  "MySQL": true,
  "Redis": false,
  "Local": true,
  "Clickhouse": false,
  "Kafka": false
}
```
```

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

### Configuration Types

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Defines configuration structures for Kafka consumers and topics, local cache, MySQL, and Redis (including Sentinel).

```APIDOC
## Configuration Types

### ConfigKafkaConsumerGroup
Represents configuration for a Kafka consumer group.

### ConfigKafkaTopic
Represents configuration for a Kafka topic.

### ConfigLocalCache
Represents configuration for a local cache.

### ConfigMysql
Represents configuration for a MySQL database connection.

### ConfigRedis
Represents configuration for a Redis connection.

### ConfigRedisSentinel
Represents configuration for a Redis connection using Sentinel for high availability.
```

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

### EngineSetter Interface

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Interface for setting configuration options on the engine.

```go
type EngineSetter interface {
	SetOption(key string, value any)
}
```

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

### Redis Search Where Clause Builder

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Fluent interface for building search conditions and options.

```go
func NewRedisSearchWhere() *RedisSearchWhere
func (w *RedisSearchWhere) Bool(field string, value bool) *RedisSearchWhere
func (w *RedisSearchWhere) Float64Equal(field string, value float64) *RedisSearchWhere
func (w *RedisSearchWhere) Float64Max(field string, max float64) *RedisSearchWhere
func (w *RedisSearchWhere) Float64Min(field string, min float64) *RedisSearchWhere
func (w *RedisSearchWhere) Float64Range(field string, min, max float64) *RedisSearchWhere
func (w *RedisSearchWhere) GetSearchOptions(offset, count int) *redis.FTSearchOptions
func (w *RedisSearchWhere) Int64Equal(field string, value int64) *RedisSearchWhere
func (w *RedisSearchWhere) Int64Max(field string, max int64) *RedisSearchWhere
func (w *RedisSearchWhere) Int64Min(field string, min int64) *RedisSearchWhere
func (w *RedisSearchWhere) Int64Range(field string, min, max int64) *RedisSearchWhere
func (w *RedisSearchWhere) SortBy(field string, ascending bool) *RedisSearchWhere
func (w *RedisSearchWhere) String() string
func (w *RedisSearchWhere) Tag(field string, values ...string) *RedisSearchWhere
func (w *RedisSearchWhere) Text(field string, text string) *RedisSearchWhere
func (w *RedisSearchWhere) Uint64Equal(field string, value uint64) *RedisSearchWhere
func (w *RedisSearchWhere) Uint64Max(field string, max uint64) *RedisSearchWhere
func (w *RedisSearchWhere) Uint64Min(field string, min uint64) *RedisSearchWhere
```

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

### Set Multiple Parameters in BaseWhere

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

SetParameters replaces all existing parameters with the provided ones. Use this to efficiently update multiple parameters at once.

```go
func (w *BaseWhere) SetParameters(params ...any) *BaseWhere
```

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

### Query Building

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Tools for constructing database queries with filtering, sorting, and pagination.

```APIDOC
## DBQuery

### Description
Provides a fluent interface for building complex database queries.

### Methods
- **Filter(conditions ...Condition)** - Adds filtering conditions to the query.
- **SortByASC(f Field)** - Adds an ascending sort clause.
- **SortByDESC(f Field)** - Adds a descending sort clause.
- **Pager(p *Pager)** - Applies pagination to the query.
```

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

### Kafka Interface

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Pool-level interface for interacting with Kafka brokers and consumer groups.

```go
type Kafka interface {
	GetCode() string
	GetBrokers() []string
	GetPoolOptions() *KafkaPoolOptions
	ProduceSync(ctx Context, records ...*KafkaRecord) error
	Produce(ctx Context, record *KafkaRecord, callback func(*KafkaRecord, error))
	ConsumerGroup(name string) (KafkaConsumerGroup, error)
	MustConsumerGroup(name string) KafkaConsumerGroup
	ConsumerGroupNames() []string
	Close()
}
```

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

### RedisSearchQuery Builder

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Methods for initializing and configuring a Redis search query, including filtering, pagination, and sorting.

```APIDOC
## RedisSearchQuery

### Description
RedisSearchQuery is a type-safe query builder for Redis FT.SEARCH queries.

### Methods
- **NewRedisSearchQuery()**: Creates a new empty RedisSearchQuery.
- **BuildQueryString()**: Returns the FT.SEARCH query string. Returns "*" if no conditions.
- **BuildSearchOptions(offset, count int)**: Returns FTSearchOptions for go-redis.
- **Filter(conditions ...RedisSearchCondition)**: Adds conditions to the query.
- **Pager(p *Pager)**: Sets the pagination for the query.
- **SortByASC(f RedisSearchField)**: Sets ascending sort on the given field.
- **SortByDESC(f RedisSearchField)**: Sets descending sort on the given field.
```

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

### Redis Pipeline Exec Method

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Executes all queued commands in the Redis pipeline and returns the responses and any error.

```go
func (rp *RedisPipeLine) Exec(ctx Context) (response []redis.Cmder, err error)
```

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

### ClickhouseTableBuilder Methods

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Methods for configuring Clickhouse table structures and columns.

```APIDOC
## ColumnDefault

### Description
Adds a column with a DEFAULT expression.

### Parameters
- **name** (string) - Required - Column name
- **typeName** (string) - Required - Column type
- **defaultExpr** (string) - Required - Default expression

## ColumnFull

### Description
Adds a column with all possible options.

### Parameters
- **name** (string) - Required - Column name
- **typeName** (string) - Required - Column type
- **opts** (ClickhouseColumnOptions) - Required - Column options

## ColumnMaterialized

### Description
Adds a column with a MATERIALIZED expression.

### Parameters
- **name** (string) - Required - Column name
- **typeName** (string) - Required - Column type
- **expr** (string) - Required - Materialized expression

## ColumnTTL

### Description
Adds a column with a column-level TTL expression.

### Parameters
- **name** (string) - Required - Column name
- **typeName** (string) - Required - Column type
- **ttl** (string) - Required - TTL expression

## Engine

### Description
Sets the table engine (e.g. "MergeTree", "ReplacingMergeTree(Version)").

### Parameters
- **engine** (string) - Required - Engine name

## OrderBy

### Description
Sets the ORDER BY columns.

### Parameters
- **columns** (...string) - Required - List of columns
```

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

### Kafka Pool Options

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Configuration options for a Kafka pool.

```APIDOC
## KafkaPoolOptions Struct

### Description
Configuration options for a Kafka pool.

### Fields
- **ClientID** (string) - The client ID for the Kafka connection.
- **RequiredAcks** (int) - Controls the number of acknowledgments required from the leader. 0=none, 1=leader, -1=all.
- **ProducerLinger** (time.Duration) - The linger duration for the producer.
- **MaxBufferedRecords** (int) - The maximum number of records to buffer.
- **SASL** (*KafkaSASLConfig) - SASL authentication configuration.
- **IgnoredTopics** ([]string) - A list of topics to ignore.
- **IgnoredConsumerGroups** ([]string) - A list of consumer groups to ignore.
```

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

### DBQuery Builder Methods

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Methods for constructing SQL queries, including filtering, sorting, and pagination.

```APIDOC
## DBQuery Methods

### Description
Methods to build SQL clauses and manage query state for database operations.

### Methods
- **BuildOrderClause()**: Returns the ORDER BY SQL string.
- **BuildWhereClause()**: Returns the WHERE SQL string and parameters.
- **Filter(conditions ...Condition)**: Adds typed conditions to the query.
- **FilterWhere(w Where)**: Adds a raw Where clause.
- **SortByASC(f Field)**: Adds an ascending sort clause.
- **SortByDESC(f Field)**: Adds a descending sort clause.
- **Pager(p *Pager)**: Sets pagination for the query.
```

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

### Iterate over Kafka Records

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

EachRecord iterates over the Kafka records in the fetches. It takes a function that accepts a pointer to a KafkaRecord.

```go
func (f KafkaFetches) EachRecord(fn func(*KafkaRecord))
```

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

### AsyncSQLQuery and AsyncSQLParam

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Structures for representing asynchronous SQL queries with typed parameters.

```APIDOC
## AsyncSQLParam

### Description
A typed parameter envelope for serializing SQL parameters.

### Fields
- **Null** (bool) - Optional - Indicates if the parameter is NULL.
- **Type** (string) - Required - The type of the parameter. Possible values: "s" (string), "i" (integer), "u" (unsigned integer), "f" (float), "b" (boolean), "t" (timestamp).
- **Val** (string) - Required - The string representation of the parameter's value.

### Example
```json
{
  "n": false,
  "t": "i",
  "v": "123"
}
```

## AsyncSQLParam.Value

### Description
Converts the parameter back to a Go type.

### Method
`func (p AsyncSQLParam) Value() any`

### Endpoint
N/A (Method on AsyncSQLParam)

### Request Example
```go
var param AsyncSQLParam = AsyncSQLParam{Type: "i", Val: "42"}
value := param.Value()
// value will be an int with value 42
```

## AsyncSQLQuery

### Description
Holds a single SQL statement with its typed parameters.

### Fields
- **Q** (string) - Required - The SQL query string.
- **P** ([]AsyncSQLParam) - Required - A slice of typed parameters for the query.

### Example
```json
{
  "q": "SELECT * FROM users WHERE id = ?",
  "p": [
    {
      "n": false,
      "t": "i",
      "v": "1"
    }
  ]
}
```
```

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

### Redis Pipeline MSet Method

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Sets multiple key-value pairs in Redis within a pipeline.

```go
func (rp *RedisPipeLine) MSet(pairs ...any)
```

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

### Field Interface

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Implemented by all field types for use in sorting operations.

```go
type Field interface {
	ColumnName() string
}
```

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

### Mock DB Client Operations

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Provides methods for mocking database client interactions.

```APIDOC
## POST /mockdbclient/exec

### Description
Executes a query on the mock database client.

### Method
POST

### Endpoint
/mockdbclient/exec

### Parameters
#### Request Body
- **m** (*MockDBClient) - Required - The mock database client instance.
- **query** (string) - Required - The SQL query to execute.
- **args** ([]any) - Optional - Arguments for the query.

### Response
#### Success Response (200)
- **result** (sql.Result) - The result of the query execution.
- **error** (error) - nil if successful, otherwise an error object.

#### Response Example
```json
{
  "result": {
    "rowsAffected": 1,
    "lastInsertId": 0
  },
  "error": null
}
```

## POST /mockdbclient/exec_context

### Description
Executes a query with context on the mock database client.

### Method
POST

### Endpoint
/mockdbclient/exec_context

### Parameters
#### Request Body
- **m** (*MockDBClient) - Required - The mock database client instance.
- **context** (context.Context) - Required - The context for the operation.
- **query** (string) - Required - The SQL query to execute.
- **args** ([]any) - Optional - Arguments for the query.

### Response
#### Success Response (200)
- **result** (sql.Result) - The result of the query execution.
- **error** (error) - nil if successful, otherwise an error object.

#### Response Example
```json
{
  "result": {
    "rowsAffected": 1,
    "lastInsertId": 0
  },
  "error": null
}
```

## POST /mockdbclient/query

### Description
Queries the mock database client.

### Method
POST

### Endpoint
/mockdbclient/query

### Parameters
#### Request Body
- **m** (*MockDBClient) - Required - The mock database client instance.
- **query** (string) - Required - The SQL query to execute.
- **args** ([]any) - Optional - Arguments for the query.

### Response
#### Success Response (200)
- **rows** (*sql.Rows) - The rows returned by the query.
- **error** (error) - nil if successful, otherwise an error object.

#### Response Example
```json
{
  "rows": { /* sql.Rows object details */ },
  "error": null
}
```

## POST /mockdbclient/query_context

### Description
Queries with context on the mock database client.

### Method
POST

### Endpoint
/mockdbclient/query_context

### Parameters
#### Request Body
- **m** (*MockDBClient) - Required - The mock database client instance.
- **context** (context.Context) - Required - The context for the operation.
- **query** (string) - Required - The SQL query to execute.
- **args** ([]any) - Optional - Arguments for the query.

### Response
#### Success Response (200)
- **rows** (*sql.Rows) - The rows returned by the query.
- **error** (error) - nil if successful, otherwise an error object.

#### Response Example
```json
{
  "rows": { /* sql.Rows object details */ },
  "error": null
}
```

## POST /mockdbclient/query_row

### Description
Queries a single row from the mock database client.

### Method
POST

### Endpoint
/mockdbclient/query_row

### Parameters
#### Request Body
- **m** (*MockDBClient) - Required - The mock database client instance.
- **query** (string) - Required - The SQL query to execute.
- **args** ([]any) - Optional - Arguments for the query.

### Response
#### Success Response (200)
- **row** (*sql.Row) - The single row returned by the query.

#### Response Example
```json
{
  "row": { /* sql.Row object details */ }
}
```
```

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

### Kafka Topic Builder

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Fluent API for defining and configuring Kafka topic schemas.

```APIDOC
## KafkaTopicBuilder

### Description
Provides a fluent interface to define Kafka topic configurations including partitions, replication, and retention policies.

### Methods
- **NewKafkaTopic(topicName, poolCode)**: Initializes a new builder.
- **CleanupPolicy(policy)**: Sets cleanup.policy (delete, compact).
- **CompressionType(ct)**: Sets compression.type (gzip, snappy, etc.).
- **Config(key, value)**: Sets arbitrary key-value configuration.
- **MaxMessageBytes(bytes)**: Sets max.message.bytes.
- **MinInsyncReplicas(n)**: Sets min.insync.replicas.
- **Partitions(n)**: Sets number of partitions.
- **ReplicationFactor(n)**: Sets replication factor.
- **RetentionBytes(bytes)**: Sets retention.bytes.
- **RetentionMs(ms)**: Sets retention.ms.
```

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

### Clickhouse Table Builder

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Fluent API for defining Clickhouse table structures.

```APIDOC
## ClickhouseTableBuilder

### Description
Allows for the programmatic definition of Clickhouse tables, including columns, engines, and partitioning.

### Methods
- **Column(name, typeName string)** - Adds a column to the table definition.
- **Engine(engine string)** - Sets the table engine.
- **PartitionBy(expr string)** - Sets the partition expression.
- **OrderBy(columns ...string)** - Sets the sorting order for the table.
```

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

### ClickhouseConfig Interface Definition

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

The ClickhouseConfig interface defines methods for retrieving ClickHouse configuration details, including code, data source URI, database name, and options.

```go
type ClickhouseConfig interface {
	GetCode() string
	GetDataSourceURI() string
	GetDatabaseName() string
	GetOptions() *ClickhouseOptions
	// contains filtered or unexported methods
}
```

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

### IntField Type and Methods

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Represents a signed integer column with various comparison methods.

```go
type IntField struct{ Column string }
```

```go
func (f IntField) ColumnName() string
```

```go
func (f IntField) Eq(v int64) Condition
```

```go
func (f IntField) Gt(v int64) Condition
```

```go
func (f IntField) Gte(v int64) Condition
```

```go
func (f IntField) In(values ...int64) Condition
```

```go
func (f IntField) Lt(v int64) Condition
```

```go
func (f IntField) Lte(v int64) Condition
```

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

### Define PipeLineSlice Structure

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Represents a pipeline that returns a slice of strings.

```go
type PipeLineSlice struct {
	// contains filtered or unexported fields
}
```

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

### Implement AsyncSQLParam Value Method

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

The Value method converts an AsyncSQLParam back to a Go any type. This is useful for retrieving the original parameter value.

```go
func (p AsyncSQLParam) Value() any
```

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

### Create new Kafka Consumer Group Builder

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

NewKafkaConsumerGroup creates a new Kafka consumer group builder, initializing it with a name and pool code.

```go
func NewKafkaConsumerGroup(name, poolCode string) *KafkaConsumerGroupBuilder
```

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

### Execute Alter Statement

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Executes an ALTER statement against the database.

```go
func (a Alter) Exec(ctx Context) error
```

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

### Redis Pipeline Operations

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Methods for executing standard Redis commands within a pipeline context.

```go
func (rp *RedisPipeLine) HSet(key string, values ...any)
```

```go
func (rp *RedisPipeLine) LPush(key string, values ...any)
```

```go
func (rp *RedisPipeLine) LRange(key string, start, stop int64) *PipeLineSlice
```

```go
func (rp *RedisPipeLine) LSet(key string, index int64, value any)
```

```go
func (rp *RedisPipeLine) MSet(pairs ...any)
```

```go
func (rp *RedisPipeLine) RPush(key string, values ...any)
```

```go
func (rp *RedisPipeLine) SAdd(key string, members ...any)
```

```go
func (rp *RedisPipeLine) SRem(key string, members ...any)
```

```go
func (rp *RedisPipeLine) Set(key string, value any, expiration time.Duration)
```

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

### Execute a Kafka operation

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Exec executes the pending Kafka operation defined by KafkaAlter. Requires a Context.

```go
func (a KafkaAlter) Exec(ctx Context) error
```

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

### Async Redis Operation

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Represents a recorded Redis command for deferred execution. Added in v2.1.0.

```go
type AsyncRedisOp struct {
	Pool string   `msgpack:"p"`
	Cmd  string   `msgpack:"c"`
	Args []string `msgpack:"a,omitempty"`
}
```

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

### Clickhouse Interface and Configuration

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Defines the ClickHouse interface for database operations and configuration details.

```APIDOC
## Clickhouse Interface

### Description
Defines the contract for interacting with a ClickHouse database.

### Methods
- **GetConfig() ClickhouseConfig**: Returns the configuration for the ClickHouse instance.
- **GetDBClient() DBClient**: Returns the underlying DB client.
- **SetMockDBClient(mock DBClient)**: Sets a mock DB client for testing.
- **Exec(ctx Context, query string, args ...any) (ExecResult, error)**: Executes a query that does not return rows.
- **QueryRow(ctx Context, query Where, toFill ...any) (found bool, err error)**: Executes a query expecting a single row.
- **Query(ctx Context, query string, args ...any) (rows Rows, close func(), err error)**: Executes a query that returns multiple rows.

## ClickhouseConfig Interface

### Description
Defines the configuration interface for a ClickHouse connection.

### Methods
- **GetCode() string**: Returns the unique code for this configuration.
- **GetDataSourceURI() string**: Returns the data source name (DSN) URI.
- **GetDatabaseName() string**: Returns the name of the database.
- **GetOptions() *ClickhouseOptions**: Returns additional connection options.

## ClickhouseOptions Struct

### Description
Holds optional settings for a ClickHouse connection pool.

### Fields
- **ConnMaxLifetime** (time.Duration) - Maximum lifetime of a connection.
- **MaxOpenConnections** (int) - Maximum number of open connections.
- **MaxIdleConnections** (int) - Maximum number of idle connections.
- **IgnoredTables** ([]string) - List of table names to ignore during schema synchronization.
```

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

### Set Topics for Consumer Group

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Topics sets the topics for this consumer group. This method returns the builder for chaining.

```go
func (b *KafkaConsumerGroupBuilder) Topics(topics ...string) *KafkaConsumerGroupBuilder
```

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

### PipeLine Result Types

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Types for handling pipeline query results.

```go
type PipeLineBool struct {
	// contains filtered or unexported fields
}
```

```go
func (c *PipeLineBool) Result() (bool, error)
```

```go
type PipeLineGet struct {
	// contains filtered or unexported fields
}
```

```go
func (c *PipeLineGet) Result() (value string, has bool, err error)
```

```go
type PipeLineInt struct {
	// contains filtered or unexported fields
}
```

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

### Retrieve PipeLineString Result

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Returns the string result of the pipeline execution.

```go
func (c *PipeLineString) Result() (string, error)
```

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

### Define Context Interface

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

The primary interface for managing ORM context, caching, and database pipelines.

```go
type Context interface {
	Context() context.Context
	Clone() Context
	CloneWithContext(context context.Context) Context
	Engine() Engine
	DisableContextCache()
	SetContextCacheTTL(ttl time.Duration)
	Flush() error
	FlushAsync(immediateRedisUpdates bool) error
	GetAsyncSQLConsumer() (AsyncSQLConsumer, error)
	ClearFlush()
	RedisPipeLine(pool string) *RedisPipeLine
	DatabasePipeLine(pool string) *DatabasePipeline
	RegisterQueryLogger(handler LogHandler, options QueryLoggerOptions)
	EnableQueryDebug()
	EnableQueryDebugCustom(options QueryLoggerOptions)
	SetMetaData(key, value string)
	GetMetaData() Meta

	Track(e Entity, cacheIndex uint64)

	GetFromContextCache(cacheIndex uint64, id uint64) Entity
	SetInContextCache(cacheIndex uint64, id uint64, entity Entity)
	// contains filtered or unexported methods
}
```

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

### Define Database Interfaces

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Core interfaces for database operations, including transaction support and query execution.

```go
type DB interface {
	DBBase
	Begin(ctx Context) (DBTransaction, error)
}
```

```go
type DBBase interface {
	GetConfig() MySQLConfig
	GetDBClient() DBClient
	SetMockDBClient(mock DBClient)
	Exec(ctx Context, query string, args ...any) (ExecResult, error)
	QueryRow(ctx Context, query Where, toFill ...any) (found bool, err error)
	Query(ctx Context, query string, args ...any) (rows Rows, close func(), err error)
}
```

```go
type DBClient interface {
	DBClientQuery
}
```

```go
type DBClientNoTX interface {
	DBClientQuery
	Begin() (*sql.Tx, error)
}
```

```go
type DBClientQuery interface {
	Exec(query string, args ...any) (sql.Result, error)
	ExecContext(context context.Context, query string, args ...any) (sql.Result, error)
	QueryRow(query string, args ...any) *sql.Row
	QueryRowContext(context context.Context, query string, args ...any) *sql.Row
	Query(query string, args ...any) (*sql.Rows, error)
	QueryContext(context context.Context, query string, args ...any) (*sql.Rows, error)
}
```

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

### ExecResult Interface

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Interface for handling execution results from database operations.

```go
type ExecResult interface {
	LastInsertId() (uint64, error)
	RowsAffected() (uint64, error)
}
```

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

### Redis Search Entity Provider Interface

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Implement this interface for entities that require Redis Search indexing. It defines methods for reindexing, retrieving the search code, index name, and hash prefix.

```go
type RedisSearchEntityProvider interface {
	ReindexRedisSearch(ctx Context) error
	RedisSearchCode() string
	RedisSearchIndexName() string
	RedisSearchHashPrefix() string
}
```

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

### Redis Search Int Field Between Method

Source: https://pkg.go.dev/github.com/latolukasz/fluxaorm/v2

Creates a Redis Search condition for a range between two int64 values. Added in v2.2.2.

```go
func (f RedisSearchIntField) Between(min, max int64) RedisSearchCondition
```
Tokens:
Raw