libovsdb

https://pkg.go.dev/github.com/ovn-org/libovsdb
Admin
libovsdb is a Go library that provides an API for connecting to, monitoring, and interacting with...
Tokens:41,501
Snippets:380
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Interact with OVSDB using Generated Models

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb

Load the generated ClientDBModel, connect to the OVSDB server, monitor all data, and interact with database objects like LogicalRouter. This example shows how to get a LogicalRouter and print its details.

```go
import (
    "fmt"
    "github.com/ovn-org/libovsdb/client"

    generated "example.com/example/mypackage"
)

func main() {
    dbModelReq, _ := generated.FullDatabaseModel()
    ovs, _ := client.Connect(context.Background(), dbModelReq, client.WithEndpoint("tcp:localhost:6641"))
    ovs.MonitorAll()

    // Create a *LogicalRouter, as a pointer to a Model is required by the API
    lr := &generated.LogicalRouter{
        Name: "myRouter",
    }
    ovs.Get(lr)
    fmt.Printf("My Router has UUID: %s and %d Ports\n", lr.UUID, len(lr.Ports))
}

```

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

### Install and Use modelgen Code Generator

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb

Install the modelgen tool using go install. Then, use it to generate Go models from an OVSDB schema file, specifying the package name and output directory.

```bash
go install github.com/ovn-org/libovsdb/cmd/modelgen

$GOPATH/bin/modelgen -p ${PACKAGE_NAME} -o {OUT_DIR} ${OVSDB_SCHEMA}
```

```bash
Usage of modelgen:
        modelgen [flags] OVS_SCHEMA
Flags:
  -d    Dry run
  -o string
        Directory where the generated files shall be stored (default ".")
  -p string
        Package name (default "ovsmodel")

```

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

### Execute Tests with make

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb

The 'make' command simplifies the test execution process by automatically starting the necessary containers and running 'make test-local' within the test container.

```bash
make test-local
```

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

### List All Elements in a Table

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb

Example of how to retrieve all elements from a specific table in the OVS database. Ensure the `MyLogicalSwitch` type is correctly defined and imported.

```go
var lsList *[]MyLogicalSwitch
ovs.List(lsList)

for _, ls := range lsList {
    fmt.Printf("%+v\n", ls)
}

```

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

### Run Integration Tests with Docker

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb

Set up Docker and use docker-compose to run integration tests. This involves starting OVS containers and executing tests within them.

```bash
export DOCKER_IP=$(boot2docker ip)

docker-compose run test /bin/sh
# make test-local
...
# exit
docker-compose down

```

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

### Retrieve Model with Get

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Get retrieves a single model instance based on its schema indexes.

```go
ls := &LogicalSwitch{UUID:"myUUID"}
err := ovs.Get(ls)
fmt.Printf("Name of the switch is: &s", ls.Name)
```

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

### Get OVSDB Database Model

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/test

Retrieves the database model for OVSDB. No setup or imports are required beyond the package itself.

```go
func GetModel() (model.DatabaseModel, error)
```

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

### Get OVSDB Database Schema

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/test

Retrieves the database schema for OVSDB. No setup or imports are required beyond the package itself.

```go
func GetSchema() (ovsdb.DatabaseSchema, error)
```

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

### Create Partial DatabaseModel without Schema

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/model

Returns a DatabaseModel that does not yet have an associated schema. Useful for initial client setup.

```go
func NewPartialDatabaseModel(client ClientDBModel) DatabaseModel
```

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

### Get Database Name

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/model

Returns the name of the database associated with the ClientDBModel.

```go
func (db ClientDBModel) Name() string
```

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

### Monitor Database Updates with Event Handlers

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb

Sets up a notification handler to receive real-time updates for added, deleted, or updated elements in the OVS database. This example specifically logs when a new 'Logical_Switch' is added.

```go
handler := &cache.EventHandlerFuncs{
    AddFunc: func(table string, model model.Model) {
        if table == "Logical_Switch" {
            fmt.Printf("A new switch named %s was added!!\n!", model.(*MyLogicalSwitch).Name)
        }
    },
}
ovs.Cache.AddEventHandler(handler)

```

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

### Get Client Indexes for a Model

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/model

Retrieves the client-defined indexes for a specific table within the model.

```go
func (db ClientDBModel) Indexes(table string) []ClientIndex
```

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

### Define Model Interface and Example

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/model

The Model interface defines how OVSDB data maps to structs. Requires an 'ovs' tag and a mandatory '_uuid' field.

```go
type Model interface{}
```

```go
type MyLogicalRouter struct {
	UUID          string            `ovsdb:"_uuid"`
	Name          string            `ovsdb:"name"`
	ExternalIDs   map[string]string `ovsdb:"external_ids"`
	LoadBalancers []string          `ovsdb:"load_balancer"`
}
```

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

### Get an Element by its Index

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb

Retrieves a specific element from the OVS database. This example assumes that 'Name' is part of the table's index, allowing for efficient retrieval.

```go
ls := &MyLogicalSwitch{Name: "foo"} // "name" is in the table index list
ovs.Get(ls)

```

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

### Get Operation

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Retrieves a single model based on its schema indexes.

```APIDOC
## GET Operation

The `Get()` operation retrieves a single model instance based on its schema indexes.

### Method
GET (implicitly through library function)

### Endpoint
N/A (Client-side operation)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```go
ls := &LogicalSwitch{UUID: "myUUID"}
err := ovs.Get(ls)
fmt.Printf("Name of the switch is: %s\n", ls.Name)
```

### Response
#### Success Response (200)
Populates the provided model with data retrieved from the OVSDB.

#### Response Example
(The `ls` object will be populated)
```json
{
  "Name": "exampleSwitchName"
}
```
```

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

### NewInfo Function

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/mapper

Creates a new Info structure, which associates a Go object with its OVSDB table schema. This is the starting point for using the Mapper with a specific object.

```go
func NewInfo(tableName string, table *ovsdb.TableSchema, obj interface{}) (*Info, error)
```

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

### Get Table Template Data

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/modelgen

Returns the TableTemplateData map for a given table schema.

```go
func GetTableTemplateData(pkg, name string, table *ovsdb.TableSchema) TableTemplateData
```

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

### Define Struct with OVSDB Tag

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/mapper

Example of how to define a Go struct with an 'ovsdb' tag to map fields to OVSDB columns. The tag format is 'ovsdb:"${COLUMN_NAME}"'.

```go
type MyObj struct {
	Name string `ovsdb:"name"`
}
```

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

### Update an Existing Element

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb

Example of how to update an existing element in the OVS database. Changes are applied to the element, and then `Update` generates the operations for transaction.

```go
ls.Config["foo"] = "bar"
ops, _ := ovs.Where(ls).Update(&ls)
ovs.Transact(ops...)

```

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

### Define OVSDB API Interface

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Defines the core API for interacting with an OVSDB database, including listing, getting, creating, and filtering data.

```go
type API interface {
	// List populates a slice of Models objects based on their type
	// The function parameter must be a pointer to a slice of Models
	// Models can be structs or pointers to structs
	// If the slice is null, the entire cache will be copied into the slice
	// If it has a capacity != 0, only 'capacity' elements will be filled in
	List(ctx context.Context, result interface{}) error

	// Create a Conditional API from a Function that is used to filter cached data
	// The function must accept a Model implementation and return a boolean. E.g:
	// ConditionFromFunc(func(l *LogicalSwitch) bool { return l.Enabled })
	WhereCache(predicate interface{}) ConditionalAPI

	// Create a ConditionalAPI from a Model's index data, where operations
	// apply to elements that match the values provided in one or more
	// model.Models according to the indexes. All provided Models must be
	// the same type or an error will be generated when operations are
	// are performed on the ConditionalAPI.
	Where(...model.Model) ConditionalAPI

	// WhereAny creates a ConditionalAPI from a list of Conditions where
	// operations apply to elements that match any (eg, logical OR) of the
	// conditions.
	WhereAny(model.Model, ...model.Condition) ConditionalAPI

	// WhereAll creates a ConditionalAPI from a list of Conditions where
	// operations apply to elements that match all (eg, logical AND) of the
	// conditions.
	WhereAll(model.Model, ...model.Condition) ConditionalAPI

	// Get retrieves a model from the cache
	// The way the object will be fetch depends on the data contained in the
	// provided model and the indexes defined in the associated schema
	// For more complex ways of searching for elements in the cache, the
	// preferred way is Where({condition}).List()
	Get(context.Context, model.Model) error

	// Create returns the operation needed to add the model(s) to the Database
	// Only fields with non-default values will be added to the transaction. If
	// the field associated with column "_uuid" has some content other than a
	// UUID, it will be treated as named-uuid
	Create(...model.Model) ([]ovsdb.Operation, error)
}
```

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

### Connect to OVSDB and Monitor

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb

Establishes a connection to an OVSDB endpoint and optionally enables the built-in cache for monitoring. Ensure the context is properly managed.

```go
ovs, _ := client.Connect(context.Background(), dbModelReq, client.WithEndpoint("tcp:172.18.0.4:6641"))
client.MonitorAll(nil) // Only needed if you want to use the built-in cache

```

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

### Configure TLS Settings

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Sets the TLS configuration for the client connection.

```go
func WithTLSConfig(cfg *tls.Config) Option
```

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

### Generate Go Models with go generate

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb

Create a gen.go file with a go:generate directive to run modelgen. Then, execute go generate to create the Go model files based on the schema.

```bash
cat <<EOF > mypackage/gen.go
package mypackage

// go:generate modelgen -p mypackage -o . ovs-nb.ovsschema
EOF
go generate "./..."

```

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

### Connect to OVSDB Server

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Establish a connection to an OVSDB server using the provided context and the `ClientDBModel`. The returned `ovs` client instance can then be used for database interactions.

```go
ovs, _ := client.Connect(context.Background(), clientDBModel)

```

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

### Get Column Tag

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/modelgen

Returns the Tag string associated with a specific column.

```go
func Tag(column string) string
```

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

### Improve Query Performance with Client Indexes

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb

Demonstrates how to improve query performance by setting up client-side indexes for specific tables and columns. This is useful when frequently querying based on specific map keys within a column.

```go
// slow predicate run on all the LB table rows...
ovn.WhereCache(func (lb *LoadBalancer) bool {
    return lb.ExternalIds["myIdKey"] == "myIdValue"
}).List(ctx, &results)

```

```go
dbModel, err := nbdb.FullDatabaseModel()
dbModel.SetIndexes(map[string][]model.ClientIndex{
    "Load_Balancer": {{Columns: []model.ColumnKey{{Column: "external_ids", Key: "myIdKey"}}}},
})

// connect ....

lb := &LoadBalancer{
    ExternalIds: map[string]string{"myIdKey": "myIdValue"},
}
// quick indexed result
ovn.Where(lb).List(ctx, &results)

```

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

### Create ClientDBModel

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/model

Constructs a ClientDBModel using a database name and a map of models indexed by table name. Returns an error if construction fails.

```go
func NewClientDBModel(name string, models map[string]Model) (ClientDBModel, error)
```

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

### Get Struct Name from Table

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/modelgen

Returns the name of the table struct based on the provided table name.

```go
func StructName(tableName string) string
```

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

### Create New Model Instance

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/model

Returns a new instance of a model based on the provided table name.

```go
func (db DatabaseModel) NewModel(table string) (Model, error)
```

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

### Create DatabaseModel from Schema and Client

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/model

Returns a new DatabaseModel by combining an OVSDB schema and client information. May return multiple errors.

```go
func NewDatabaseModel(schema ovsdb.DatabaseSchema, client ClientDBModel) (DatabaseModel, []error)
```

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

### OVSDB Client Connection and Data Modeling

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Demonstrates how to establish a connection to an OVSDB server and define database models.

```APIDOC
## OVSDB Client Connection and Data Modeling

### Description
This section explains how to define data models for OVSDB tables and establish a client connection to an OVSDB server.

### Data Modeling
Models are Go structs with `ovsdb` field tags to map struct fields to OVSDB columns.

```go
type MyLogicalSwitch struct {
	UUID   string            `ovsdb:"_uuid"` // _uuid tag is mandatory
	Name   string            `ovsdb:"name"`
	Ports  []string          `ovsdb:"ports"`
	Config map[string]string `ovsdb:"other_config"`
}
```

A `ClientDBModel` represents the database schema, which is used to initialize the client.

```go
clientDBModel, _ := client.NewClientDBModel("OVN_Northbound",
    map[string]client.Model{
	"Logical_Switch": &MyLogicalSwitch{},
})
```

### Client Connection
Connect to an OVSDB server using the `Connect` function, providing the context and the `ClientDBModel`.

```go
ovs, _ := client.Connect(context.Background(), clientDBModel)
```
```

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

### Create Models

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Create generates operations to add new models to the database.

```go
ops, err := ovs.Create(&LogicalSwitch{Name:"foo")}, &LogicalSwitch{Name:"bar"})
```

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

### Create New In-Memory Database

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/database/inmemory

Use this function to initialize a new in-memory database. It requires a map of models to be provided.

```go
func NewDatabase(models map[string]model.ClientDBModel) dbase.Database
```

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

### Get Length of RowCache

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/cache

The Len method returns the total number of rows currently stored in the RowCache. This provides a quick count of cached items.

```go
func (r *RowCache) Len() int
```

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

### Define Connection Protocols

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Constants for defining connection protocols like SSL, TCP, and UNIX sockets.

```go
const (
	SSL  = "ssl"
	TCP  = "tcp"
	UNIX = "unix"
)
```

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

### Create New Generator

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/modelgen

Returns a new instance of a Generator.

```go
func NewGenerator(opts ...Option) (Generator, error)
```

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

### NewDBTemplate Function

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/modelgen

Returns a new ClientDBModel template with customizable sub-templates for headers and definitions.

```go
func NewDBTemplate() *template.Template
```

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

### GetDBTemplateData Function

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/modelgen

Returns a map containing the necessary data to execute the DBTemplate, including database name, package name, and table list.

```go
func GetDBTemplateData(pkg string, schema ovsdb.DatabaseSchema) map[string]interface{}
```

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

### Delete Rows Using Where Clause

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb

Generates OVSDB delete operations based on provided models. The `Where()` method prioritizes schema-defined or client-defined indexes, starting with the `_uuid` field, to form a condition.

```go
  ls := &LogicalSwitch{UUID: "foo"}
  ls2 := &LogicalSwitch{UUID: "foo2"}
  ops, _ := ovs.Where(ls, ls2).Delete()

```

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

### Create a New Element in OVSDB

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb

Shows how to create a new element in the OVS database. The `Create` function generates the necessary operations, which are then applied using `Transact`.

```go
ops, _ := ovs.Create(&MyLogicalSwitch{
    Name: "foo",
})

ovs.Transact(ops...)

```

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

### Configure Logger

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Sets a custom log sink for the client; defaults to the standard go log package if not provided.

```go
func WithLogger(l *logr.Logger) Option
```

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

### func NewDatabase

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/database/inmemory

Initializes a new in-memory database instance based on the provided client database models.

```APIDOC
## func NewDatabase

### Description
Creates and returns a new in-memory database implementation.

### Signature
`func NewDatabase(models map[string]model.ClientDBModel) dbase.Database`

### Parameters
- **models** (map[string]model.ClientDBModel) - Required - A map of database models used to initialize the database structure.

### Returns
- **dbase.Database** - An initialized in-memory database instance.
```

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

### Transaction Type and Constructor

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/database/transaction

Details on the Transaction type and how to create a new transaction instance.

```APIDOC
## Type: Transaction

### Description
Represents a transaction for OVSDB operations.

### Fields
- **ID** (uuid.UUID) - Unique identifier for the transaction.
- **Cache** (*cache.TableCache) - Cache for table data within the transaction.
- **DeletedRows** (map[string]struct{}) - Tracks deleted rows.
- **Model** (model.DatabaseModel) - The database model associated with the transaction.
- **DbName** (string) - The name of the database.
- **Database** (database.Database) - The database connection.

## Function: NewTransaction

### Description
Creates and returns a new Transaction instance.

### Parameters
- **model** (model.DatabaseModel) - The database model.
- **dbName** (string) - The name of the database.
- **database** (database.Database) - The database connection.
- **logger** (*logr.Logger) - A logger instance.
```

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

### Create New OVSDB Client

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Use NewOVSDBClient to instantiate a new OVSDB client with a given database model. Optional configurations can be applied using various Option functions. If no endpoint is specified, it defaults to a local Unix socket.

```go
func NewOVSDBClient(clientDBModel model.ClientDBModel, opts ...Option) (Client, error)
```

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

### Database Methods

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/ovsdb/serverdb

Provides various methods for the Database type, including cloning, deep copying, equality checks, and getters for its fields. These methods are essential for managing and interacting with Database objects.

```go
func (a *Database) CloneModel() model.Model
```

```go
func (a *Database) CloneModelInto(b model.Model)
```

```go
func (a *Database) DeepCopy() *Database
```

```go
func (a *Database) DeepCopyInto(b *Database)
```

```go
func (a *Database) Equals(b *Database) bool
```

```go
func (a *Database) EqualsModel(b model.Model) bool
```

```go
func (a *Database) GetCid() *string
```

```go
func (a *Database) GetConnected() bool
```

```go
func (a *Database) GetIndex() *int
```

```go
func (a *Database) GetLeader() bool
```

```go
func (a *Database) GetModel() DatabaseModel
```

```go
func (a *Database) GetName() string
```

```go
func (a *Database) GetSchema() *string
```

```go
func (a *Database) GetSid() *string
```

```go
func (a *Database) GetUUID() string
```

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

### Define Monitor RPC Methods

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/ovsdb

Constants for OVS monitor RPC methods.

```go
const (

	// MonitorRPC is the monitor RPC method
	MonitorRPC = "monitor"
	// ConditionalMonitorRPC is the monitor_cond
	ConditionalMonitorRPC = "monitor_cond"
	// ConditionalMonitorSinceRPC is the monitor_cond_since RPC method
	ConditionalMonitorSinceRPC = "monitor_cond_since"
)
```

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

### Set Client Indexes

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/model

Sets client-specific indexes for tables. These are optional and tracked per client instance. Indexes can span multiple models and are defined per table.

```go
func (db *ClientDBModel) SetIndexes(indexes map[string][]ClientIndex)
```

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

### Configure Metrics Registry

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Specifies a Prometheus registry for client metrics.

```go
func WithMetricsRegistry(r prometheus.Registerer) Option
```

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

### WithLogger Option

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Allows setting a specific logger for the client. If not provided, the default Go log package is used.

```APIDOC
## WithLogger Option

### Description
Allows setting a specific log sink for the client. If this option is not used, the default Go log package will be utilized.

### Function Signature
```go
func WithLogger(l *logr.Logger) Option
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

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

### WithTLSConfig Option

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Sets the TLS configuration for the client connection. This allows for secure communication with the OVSDB server.

```APIDOC
## WithTLSConfig Option

### Description
Sets the `tls.Config` for use by the client, enabling secure communication with the OVSDB server.

### Function Signature
```go
func WithTLSConfig(cfg *tls.Config) Option
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

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

### Error: Already Connected

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Error returned when attempting to connect to a database that is already connected.

```go
var ErrAlreadyConnected = errors.New("already connected")
```

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

### NewDatabaseUpdate Constructor - Go

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/updates

Creates a new DatabaseUpdate instance, bundling model updates with reference information.

```go
func NewDatabaseUpdate(updates ModelUpdates, references database.References) DatabaseUpdate
```

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

### Search Cache with a Predicate Function

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb

Demonstrates how to search the OVS cache for elements matching a specific condition defined by a predicate function. This is useful for filtering elements based on complex criteria.

```go
var lsList *[]MyLogicalSwitch
ovs.WhereCache(
    func(ls *MyLogicalSwitch) bool {
        return strings.HasPrefix(ls.Name, "ext_")
}).List(&lsList)

for _, ls := range lsList {
    fmt.Printf("%+v\n", ls)
}

```

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

### Create OVSDB Client Database Model

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb

Creates a client database model for OVSDB interaction. This involves specifying the database name and mapping table names to their corresponding Go struct models.

```go
dbModelReq, _ := model.NewClientDBModel("OVN_Northbound", map[string]model.Model{
            "Logical_Switch": &MyLogicalSwitch{},
})

```

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

### Define Condition Functions

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/ovsdb

Constants for defining comparison and inclusion/exclusion conditions.

```go
const (
	// ConditionLessThan is the less than condition
	ConditionLessThan ConditionFunction = "<"
	// ConditionLessThanOrEqual is the less than or equal condition
	ConditionLessThanOrEqual ConditionFunction = "<="
	// ConditionEqual is the equal condition
	ConditionEqual ConditionFunction = "=="
	// ConditionNotEqual is the not equal condition
	ConditionNotEqual ConditionFunction = "!="
	// ConditionGreaterThan is the greater than condition
	ConditionGreaterThan ConditionFunction = ">"
	// ConditionGreaterThanOrEqual is the greater than or equal condition
	ConditionGreaterThanOrEqual ConditionFunction = ">="
	// ConditionIncludes is the includes condition
	ConditionIncludes ConditionFunction = "includes"
	// ConditionExcludes is the excludes condition
	ConditionExcludes ConditionFunction = "excludes"

	// WaitConditionEqual is the equal condition
	WaitConditionEqual WaitCondition = "=="
	// WaitConditionNotEqual is the not equal condition
	WaitConditionNotEqual WaitCondition = "!="
)
```

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

### Configure Metrics Registry with Namespace and Subsystem

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Specifies a Prometheus registry along with custom namespace and subsystem identifiers.

```go
func WithMetricsRegistryNamespaceSubsystem(r prometheus.Registerer, namespace, subsystem string) Option
```

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

### ReferenceProvider Interface

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/updates

Interface for databases that track references. Implementations should provide methods to retrieve references and models for a given row.

```go
type ReferenceProvider interface {
	// GetReferences provides the references to the provided row
	GetReferences(database, table, uuid string) (database.References, error)
	// Get provides the corresponding model
	Get(database, table string, uuid string) (model.Model, error)
}
```

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

### Download OVSDB Schema

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb

Download the OVSDB schema from a running OVSDB server using the ovsdb-client tool. Save the schema to a local file.

```bash
ovsdb-client get-schema "tcp:localhost:6641" > mypackage/ovs-nb.ovsschema
```

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

### Retrieve DatabaseModel Client

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/model

Returns the client dbModel associated with the DatabaseModel.

```go
func (db DatabaseModel) Client() ClientDBModel
```

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

### Create OVSDB Database Model

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Build a `ClientDBModel` to represent the OVSDB schema, mapping table names to their corresponding Go struct models. This model is used by the client to encode and decode messages.

```go
clientDBModel, _ := client.NewClientDBModel("OVN_Northbound",
    map[string]client.Model{
	"Logical_Switch": &MyLogicalSwitch{},
})

```

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

### WithMetricsRegistry Option

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Allows the user to specify a Prometheus metrics registry. If provided, the metrics defined in metrics.go will be registered.

```APIDOC
## WithMetricsRegistry Option

### Description
Allows the user to specify a Prometheus metrics registry. If a registry is supplied, the metrics defined in metrics.go will be registered with it.

### Function Signature
```go
func WithMetricsRegistry(r prometheus.Registerer) Option
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

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

### ClientDBModel Structure

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/model

Represents the client information necessary for building a DatabaseModel. It contains internal fields not directly exposed.

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

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

### Create Operation

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Generates a list of operations to create new model instances.

```APIDOC
## CREATE Operation

The `Create()` operation generates OVSDB operations to create new records.

### Method
POST (implicitly through library function)

### Endpoint
N/A (Client-side operation)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
One or more models to be created.

### Request Example
```go
ops, err := ovs.Create(&LogicalSwitch{Name:"foo"}, &LogicalSwitch{Name:"bar"})
```

### Response
#### Success Response (200)
Returns a list of operations to be executed.

#### Response Example
(Operations list to be executed against OVSDB)
```

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

### NewTableTemplate Function

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/modelgen

Returns a new table template with support for custom headers, imports, fields, and definitions.

```go
func NewTableTemplate() *template.Template
```

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

### WithMetricsRegistryNamespaceSubsystem Option

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Allows specifying a Prometheus metrics registry along with a namespace and subsystem for the component using libovsdb. Registered metrics will include these identifiers.

```APIDOC
## WithMetricsRegistryNamespaceSubsystem Option

### Description
Allows the user to specify a Prometheus metrics registry, along with a namespace and subsystem for the component utilizing libovsdb. If supplied, the metrics defined in metrics.go will be registered with these identifiers.

### Function Signature
```go
func WithMetricsRegistryNamespaceSubsystem(r prometheus.Registerer, namespace, subsystem string) Option
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

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

### Define References type

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/database

Tracks references across the schema.

```go
type References map[ReferenceSpec]Reference
```

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

### List Models from Cache

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

List populates a slice of models from the cache, optionally filtered by a WhereCache condition.

```go
lsList := &[]LogicalSwitch{}
err := ovs.List(lsList) // List all elements

err := ovs.WhereCache(
    func(ls *LogicalSwitch) bool {
    	return strings.HasPrefix(ls.Name, "ext_")
}).List(lsList)
```

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

### Generate Model Information

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/model

Returns a mapper.Info object derived from the provided model interface.

```go
func (db DatabaseModel) NewModelInfo(obj interface{}) (*mapper.Info, error)
```

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

### NotOwner Error Method

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/ovsdb

Implements the error interface for NotOwner errors. Added in v0.4.0.

```go
func (e *NotOwner) Error() string
```

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

### OvsdbServer Methods

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/server

Methods for managing OVSDB server operations, transactions, and client lifecycle events.

```APIDOC
## MonitorCondSince

### Description
Monitors a given database table and provides updates to the client via an RPC callback.

### Parameters
- **client** (*rpc2.Client) - Required - The RPC client instance.
- **args** ([]json.RawMessage) - Required - Arguments for the monitor condition.
- **reply** (*ovsdb.MonitorCondSinceReply) - Required - The reply structure to populate.

---

## OnConnect

### Description
Registers a function to run when a client connects.

### Parameters
- **f** (func(*rpc2.Client)) - Required - The callback function to execute on connection.

---

## OnDisConnect

### Description
Registers a function to run when a client disconnects.

### Parameters
- **f** (func(*rpc2.Client)) - Required - The callback function to execute on disconnection.

---

## Ready

### Description
Returns true if a server is ready to handle connections.

---

## Serve

### Description
Starts the OVSDB server on the given path and protocol.

### Parameters
- **protocol** (string) - Required - The network protocol to use.
- **path** (string) - Required - The path to bind the server.

---

## Steal

### Description
Steals a lock for a client.

### Parameters
- **client** (*rpc2.Client) - Required - The RPC client instance.
- **args** ([]interface{}) - Required - Arguments for the steal operation.
- **reply** (*[]interface{}) - Required - The reply structure.

---

## Transact

### Description
Issues a new database transaction and returns the results.

### Parameters
- **client** (*rpc2.Client) - Required - The RPC client instance.
- **args** ([]json.RawMessage) - Required - The transaction operations.
- **reply** (*[]*ovsdb.OperationResult) - Required - The transaction results.

---

## Unlock

### Description
Releases a lock for a client.

### Parameters
- **client** (*rpc2.Client) - Required - The RPC client instance.
- **args** ([]interface{}) - Required - Arguments for the unlock operation.
- **reply** (*[]interface{}) - Required - The reply structure.
```

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

### Compare Two Models for Equality

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/model

Checks if two models are equal. Use for verifying state consistency.

```go
func Equal(l, r Model) bool
```

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

### Model and Utility Functions

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/model

Definitions for the Model interface and utility functions for cloning and creating models.

```APIDOC
## Model Interface and Utilities

### Model
- **Description**: The base interface used to build Database Models. Models are structs with fields tagged with 'ovs' corresponding to OVSDB column names. A field for "_uuid" is mandatory.

### Clone
- **Signature**: `func Clone(a Model) Model`
- **Description**: Creates a deep copy of a model.

### CreateModel
- **Signature**: `func CreateModel(dbModel DatabaseModel, tableName string, row *ovsdb.Row, uuid string) (Model, error)`
- **Description**: Creates a new Model instance based on OVSDB Row information.
```

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

### Error: Object Not Found

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Error indicating that a requested object or table was not found in the cache.

```go
var ErrNotFound = errors.New("object not found")
```

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

### FileName Function

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/modelgen

Returns the generated filename for a given table.

```go
func FileName(table string) string
```

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

### ClientIndex Structure

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/model

Defines a client-side index by specifying a set of columns. Used within ClientDBModel.

```go
type ClientIndex struct {
	Columns []ColumnKey
}
```

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

### Configure Inactivity Check

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Configures the client to send periodic Echo requests and handle reconnections upon failure.

```go
func WithInactivityCheck(inactivityTimeout, reconnectTimeout time.Duration,
	reconnectBackoff backoff.BackOff) Option
```

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

### List Operation

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Searches the cache and populates a slice of models. Can be used directly or with WhereCache().

```APIDOC
## LIST Operation

The `List()` operation retrieves multiple model instances from the cache.

### Method
GET (implicitly through library function)

### Endpoint
N/A (Client-side operation)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```go
// List all elements
lsList := &[]LogicalSwitch{}
err := ovs.List(lsList)

// List elements using WhereCache for filtering
lsListFiltered := &[]LogicalSwitch{}
err = ovs.WhereCache(
    func(ls *LogicalSwitch) bool {
    	return strings.HasPrefix(ls.Name, "ext_")
}).List(lsListFiltered)
```

### Response
#### Success Response (200)
Populates the provided slice with model instances matching the criteria.

#### Response Example
```json
[
  {
    "UUID": "uuid1",
    "Name": "switch1"
  },
  {
    "UUID": "uuid2",
    "Name": "switch2"
  }
]
```
```

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

### DatabaseSchema Methods

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/ovsdb

Methods for interacting with the OVSDB database schema.

```APIDOC
## DatabaseSchema.Table

### Description
Table returns a TableSchema Schema for a given table and column name.

### Method
func (schema DatabaseSchema) Table(tableName string) *TableSchema

### Endpoint
N/A (Method within a struct)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
* **TableSchema** (*TableSchema) - The schema for the specified table.

#### Response Example
None
```

```APIDOC
## DatabaseSchema.ValidateOperations

### Description
ValidateOperations performs basic validation for operations against a DatabaseSchema.

### Method
func (schema DatabaseSchema) ValidateOperations(operations ...Operation) bool

### Endpoint
N/A (Method within a struct)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **operations** (...Operation) - A variadic list of operations to validate.

### Request Example
None

### Response
#### Success Response (200)
* **bool** - True if the operations are valid, false otherwise.

#### Response Example
None
```

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

### RPC Argument Creation Functions

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/ovsdb

Functions for creating argument slices for various OVSDB RPC methods.

```APIDOC
## NewGetSchemaArgs

### Description
Creates a new set of arguments for a `get_schemas` RPC.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A

## NewLockArgs

### Description
Creates a new set of arguments for a `lock`, `steal`, or `unlock` RPC.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A

## NewMonitorArgs

### Description
Creates a new set of arguments for a `monitor` RPC.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A

## NewMonitorCancelArgs

### Description
Creates a new set of arguments for a `monitor_cancel` RPC.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A

## NewMonitorCondSinceArgs

### Description
Creates a new set of arguments for a `monitor_cond_since` RPC.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A

## NewTransactArgs

### Description
Creates a new set of arguments for a `transact` RPC.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

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

### Error: Unsupported RPC

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Error returned when an unsupported Remote Procedure Call (RPC) method is invoked.

```go
var ErrUnsupportedRPC = errors.New("unsupported rpc")
```

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

### Delete Element with Multiple Conditions

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb

Illustrates deleting an element based on multiple conditions using `WhereAll`. This ensures that the deletion only occurs if all specified conditions are met.

```go
ops, _ := ovs.Where(ls, client.Condition{
    Field: &ls.Config,
    Function: ovdb.ConditionIncludes,
    Value: map[string]string{"foo": "bar"},
}).Delete()

ovs.Transact(ops...)

ops, _ := ovs.WhereAll(ls,
    client.Condition{
        Field: &ls.Config,
        Function: ovdb.ConditionIncludes,
        Value: map[string]string{"foo": "bar"},
    }, client.Condition{
        Field: &ls.Config,
        Function: ovdb.ConditionIncludes,
        Value: map[string]string{"bar": "baz"},
    }).Delete()
ovs.Transact(ops...)

```

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

### Define Update interface

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/database

Abstracts updates that can be committed to a database.

```go
type Update interface {
	GetUpdatedTables() []string
	ForEachModelUpdate(table string, do func(uuid string, old, new model.Model) error) error
	ForEachRowUpdate(table string, do func(uuid string, row ovsdb.RowUpdate2) error) error
	ForReferenceUpdates(do func(references References) error) error
}
```

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

### EventHandlerFuncs Wrapper

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/cache

EventHandlerFuncs provides a convenient wrapper for the EventHandler interface, allowing for partial implementation of event handlers. Only the functions that are not nil will be called.

```go
type EventHandlerFuncs struct {
	AddFunc    func(table string, model model.Model)
	UpdateFunc func(table string, old model.Model, new model.Model)
	DeleteFunc func(table string, model model.Model)
}
```

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

### Model Package Functions

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/model

Provides utility functions for working with models, such as cloning and comparison.

```APIDOC
## func CloneInto

### Description
CloneInto deep copies a model into another one

### Method
func

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## func Equal

### Description
Equal checks if two models are deeply equal.

### Method
func

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Generator Interface

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/modelgen

Interface for formatting code from a template and writing it to a file.

```go
type Generator interface {
	Generate(string, *template.Template, interface{}) error
	Format(*template.Template, interface{}) ([]byte, error)
}
```

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

### DatabaseModel Structure

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/model

Represents libovsdb's metadata about a database, combining schema and client information. Contains internal fields.

```go
type DatabaseModel struct {
	Schema ovsdb.DatabaseSchema
	Mapper mapper.Mapper
	// contains filtered or unexported fields
}
```

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

### OVSDB Connection Configuration

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

The Config struct holds parameters for establishing an OVSDB connection, including the server address and TLS configuration. This is used when provisioning a connection to the OVSDB server.

```go
type Config struct {
	Addr      string
	TLSConfig *tls.Config
}
```

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

### Utility Functions

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/ovsdb

Functions for handling OVSDB types, UUID validation, and RPC argument creation.

```APIDOC
## func IsDefaultValue

### Description
Checks if a provided native element corresponds to the default value of its designated column type.

### Parameters
- **column** (*ColumnSchema) - Required - The column schema definition.
- **nativeElem** (interface{}) - Required - The native element to check.

## func IsNamedUUID

### Description
Checks if a string is a named UUID.

### Parameters
- **uuid** (string) - Required - The UUID string to validate.

## func IsValidUUID

### Description
Checks if a string is a valid UUID.

### Parameters
- **uuid** (string) - Required - The UUID string to validate.

## func NativeToOvs

### Description
Transforms a native type to an OVS type based on the column type information.

### Parameters
- **column** (*ColumnSchema) - Required - The column schema definition.
- **rawElem** (interface{}) - Required - The raw element to transform.

## func NewCancelArgs

### Description
Creates a new set of arguments for a cancel RPC.

### Parameters
- **id** (interface{}) - Required - The ID for the cancel operation.

## func NewEchoArgs

### Description
Creates a new set of arguments for an echo RPC.
```

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

### Configure Extended Generation

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/modelgen

Configures whether the template should generate code to deep copy models.

```go
func (t TableTemplateData) WithExtendedGen(val bool)
```

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

### libovsdb Utility Functions

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/ovsdb

This section covers utility functions for data conversion, validation, and OVSDB operation argument creation.

```APIDOC
## Utility Functions

### IsDefaultValue

#### Description
Checks if a given element is the default value for a column.

### IsNamedUUID

#### Description
Validates if a string is a valid named UUID.

### IsValidUUID

#### Description
Validates if a string is a valid OVS UUID.

### NativeToOvs

#### Description
Converts a native Go type to an OVSDB representation.

### NativeToOvsAtomic

#### Description
Converts a native Go type to an atomic OVSDB representation.

### NativeType

#### Description
Determines the native Go reflect.Type for a given column schema.

### NativeTypeFromAtomic

#### Description
Determines the native Go reflect.Type for an atomic OVSDB type.

### NewCancelArgs

#### Description
Creates arguments for a cancel operation.

### NewEchoArgs

#### Description
Creates arguments for an echo operation.

### NewErrWrongType

#### Description
Creates a new error indicating a type mismatch.

### NewGetSchemaArgs

#### Description
Creates arguments to retrieve schema information.

### NewLockArgs

#### Description
Creates arguments for a lock operation.

### NewMonitorArgs

#### Description
Creates arguments for a monitor operation.

### NewMonitorCancelArgs

#### Description
Creates arguments to cancel a monitor operation.

### NewMonitorCondSinceArgs

#### Description
Creates arguments for a conditional monitor operation since a specific time.

### NewTransactArgs

#### Description
Creates arguments for a transaction operation.

### OvsToNative

#### Description
Converts an OVSDB representation to a native Go type.

### OvsToNativeAtomic

#### Description
Converts an atomic OVSDB representation to a native Go type.

### OvsToNativeSlice

#### Description
Converts an OVSDB slice representation to a native Go slice.

### ValidateCondition

#### Description
Validates a condition against a column schema.

### ValidateMutation

#### Description
Validates a mutation against a column schema.

### ValidateUUID

#### Description
Validates if a string is a valid OVS UUID.

```

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

### NewMapper Function

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/mapper

Creates a new instance of the Mapper, which is used to interact with libovsdb using native Go structs. Requires an ovsdb.DatabaseSchema.

```go
func NewMapper(schema ovsdb.DatabaseSchema) Mapper
```

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

### Info Struct

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/mapper

Wraps an object with its associated metadata, including its OVSDB schema information. Used to hold data that can be mapped to OVSDB tables.

```go
type Info struct {
	// FieldName indexed by column
	Obj      interface{}
	Metadata Metadata
}
```

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

### Error: Not Connected

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Error returned when attempting an operation on a client that is not currently connected.

```go
var ErrNotConnected = errors.New("not connected")
```

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

### Define Table Monitor

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Defines the structure for monitoring specific tables, including conditions and fields.

```go
type TableMonitor struct {
	// Table is the table to be monitored
	Table string
	// Conditions are the conditions under which the table should be monitored
	Conditions []ovsdb.Condition
	// Fields are the fields in the model to monitor
	// If none are supplied, all fields will be used
	Fields []string
}
```

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

### Define Database interface

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/database

Defines the contract for database operations such as creating, querying, and committing transactions.

```go
type Database interface {
	CreateDatabase(database string, model ovsdb.DatabaseSchema) error
	Exists(database string) bool
	NewTransaction(database string) Transaction
	Commit(database string, id uuid.UUID, update Update) error
	CheckIndexes(database string, table string, m model.Model) error
	List(database, table string, conditions ...ovsdb.Condition) (map[string]model.Model, error)
	Get(database, table string, uuid string) (model.Model, error)
	GetReferences(database, table, row string) (References, error)
}
```

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

### CreateModel from Row and UUID

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/model

Creates a Model instance from an OVSDB Row and a UUID. Useful for hydrating model objects from database data.

```go
func CreateModel(dbModel DatabaseModel, tableName string, row *ovsdb.Row, uuid string) (Model, error)
```

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

### Configure Reconnection Logic

Source: https://pkg.go.dev/github.com/ovn-org/libovsdb/client

Enables automatic reconnection with a specified timeout and backoff strategy.

```go
func WithReconnect(timeout time.Duration, backoff backoff.BackOff) Option
```
Tokens:
Raw