Dbf Data Reader

https://github.com/yellowfeather/dbfdatareader
Admin
A fast .NET Core library for reading dBase, xBase, Clipper, and FoxPro database files with support...
Tokens:38,028
Snippets:524
Trust Score:8.1
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Supported SQL syntax examples

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/README.md

Examples of valid SQL commands supported by the DbfDbConnection.

```sql
select top 10 Point_ID as id, Date_Visit from dbase_03.dbf
select Point_ID, Max_PDOP from dbase_03.dbf limit 5
select Point_ID from dbase_03.dbf where Max_PDOP >= 3.5 and Date_Visit >= '1997-01-01'
select Point_ID from dbase_03.dbf where Point_ID like 'A%' or Point_ID in ('B1', 'B2')
select * from dbase_03.dbf where Point_ID = @id
select top 5 Point_ID from dbase_03.dbf where Max_PDOP >= 3.5 order by Max_PDOP desc, Point_ID
select count(*) from dbase_03.dbf where Max_PDOP >= 3.5
```

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

### Construct a connection string

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/types.md

Example of initializing the builder and generating a connection string.

```csharp
var builder = new DbfDbConnectionStringBuilder
{
    Folder = "./data",
    SkipDeletedRecords = false,
    Encoding = "utf-8"
};

var connectionString = builder.ConnectionString;
// Output: "Folder=./data;SkipDeletedRecords=False;Encoding=utf-8"
```

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

### Connection string examples

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/configuration.md

Various formats for defining connection strings.

```text
Folder=./data
```

```text
Folder=./data;SkipDeletedRecords=false;Encoding=utf-8
```

```text
Folder=C:\DBF\Archives;Encoding=iso-8859-1;StringTrimming=None;UseIndexes=false
```

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

### Access Field Data via Start

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfColumn.md

Use the Start property to slice the correct byte range from a record.

```csharp
var bytes = record.FieldBytes;  // Record data
var fieldValue = bytes.Slice(column.Start, column.Length);
```

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

### Install DbfDataReader package

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/README.md

Use the .NET CLI to add the DbfDataReader package to your project.

```bash
dotnet add package DbfDataReader
```

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

### SQL Parameter Syntax

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbCommand.md

Examples of how parameters appear within SQL query strings.

```sql
select * from contacts.dbf where id = @id
select * from contacts.dbf where id > ? and status = @status
```

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

### Execute SQL queries on DBF files

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbConnection.md

Examples of supported SQL syntax for selecting, filtering, ordering, and aggregating data from DBF files.

```sql
select Point_ID, Max_PDOP from dbase_03.dbf where Max_PDOP >= 3.5
select * from dbase_03.dbf where Point_ID like 'A%' or Point_ID in ('B1', 'B2')
select top 5 Point_ID from dbase_03.dbf where Max_PDOP >= 3.5 order by Max_PDOP desc
select count(*) from dbase_03.dbf where Date_Visit >= '1997-01-01'
```

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

### GetName C# Example

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Returns the name of the specified column.

```csharp
var columnName = reader.GetName(0);
```

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

### Close C# Example

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Closes the reader and releases associated resources.

```csharp
reader.Close();
```

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

### GetFloat C# Example

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Retrieves the value of the specified column as a float.

```csharp
var floatValue = reader.GetFloat(2);
```

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

### GetValues C# Example

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Copies all column values from the current record into a pre-allocated object array.

```csharp
var row = new object[reader.FieldCount];
reader.GetValues(row);
```

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

### GetSchemaTable C# Example

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Retrieves the schema table and iterates through rows to access column metadata.

```csharp
var schema = reader.GetSchemaTable();
foreach (DataRow row in schema.Rows)
{
    var columnName = row["ColumnName"];
}
```

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

### GetOrdinal C# Example

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Returns the column index for the specified column name. Throws an IndexOutOfRangeException if the column is not found.

```csharp
var ordinal = reader.GetOrdinal("FirstName");
var value = reader.GetString(ordinal);
```

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

### ExplainPlan()

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbCommand.md

Returns a string describing how the query will be executed.

```APIDOC
## ExplainPlan()

### Description
Returns a string describing how the query will be executed without reading any data.

### Signature
`public string ExplainPlan()`

### Returns
- **string** - A description of the query execution plan.
```

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

### Open()

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbConnection.md

Opens the connection by parsing the connection string and setting up options. The target folder must exist.

```APIDOC
## Open()

### Description
Opens the connection by parsing the connection string and setting up options. The folder must exist.

### Returns
void

### Throws
DirectoryNotFoundException if the folder does not exist

### Example
```csharp
connection.ConnectionString = "Folder=./test/fixtures";
connection.Open();
```
```

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

### Inspect query execution plan with C#

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbConnection.md

Use ExplainPlan to view how the database engine processes a specific query command.

```csharp
var command = (DbfDbCommand)connection.CreateCommand();
command.CommandText = "select * from setup.dbf where KEY_NAME = 'CONTACTS'";
Console.WriteLine(command.ExplainPlan());
// Output: index seek (=) on tag 'KEY_NAME'
```

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

### IsDBNull C# Example

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Determines whether the specified column is null.

```csharp
if (!reader.IsDBNull(0))
{
    var value = reader.GetString(0);
}
```

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

### GetValue C# Example

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Retrieves the value of the specified column as an object.

```csharp
var value = reader.GetValue(0);
```

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

### Execute a SELECT query with DbfDbCommand

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbCommand.md

Demonstrates opening a connection, defining a parameterized query, inspecting the execution plan, and iterating through results.

```csharp
var connection = new DbfDbConnection();
connection.ConnectionString = "Folder=./data";
connection.Open();

try
{
    var command = (DbfDbCommand)connection.CreateCommand();
    command.CommandText = 
        "select id, name, email, age from contacts.dbf " +
        "where age > @minAge and status = @status " +
        "order by name " +
        "limit 100";
    
    command.Parameters.AddWithValue("@minAge", 21);
    command.Parameters.AddWithValue("@status", "Active");
    
    // Check query plan before executing
    Console.WriteLine("Plan: " + command.ExplainPlan());
    
    using (var reader = command.ExecuteReader())
    {
        while (reader.Read())
        {
            var id = reader.GetInt32(0);
            var name = reader.GetString(1);
            var email = reader.GetString(2);
            var age = reader.GetInt32(3);
            
            Console.WriteLine($"{id}: {name} ({age} years) - {email}");
        }
    }
}
finally
{
    connection.Close();
}
```

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

### GetBoolean C# Example

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Retrieves the value of the specified column as a boolean.

```csharp
var boolValue = reader.GetBoolean(5);
```

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

### ExplainPlan()

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfQuery.md

Returns a string describing how the query will be executed, without actually reading any data.

```APIDOC
## ExplainPlan()

### Description
Returns a string describing how the query will be executed, without actually reading any data. Useful for debugging query performance.

### Signature
`public string ExplainPlan()`

### Returns
- **string** - Query plan description
```

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

### GetDateTime C# Example

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Retrieves the value of the specified column as a DateTime.

```csharp
var dateTime = reader.GetDateTime(2);
```

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

### Create a memo file handler

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfTable.md

Initializes a handler for FoxPro, dBase3, or dBase4 memo files based on the provided path.

```csharp
public DbfMemo CreateMemo(string path)
```

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

### GetDouble C# Example

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Retrieves the value of the specified column as a double.

```csharp
var doubleValue = reader.GetDouble(2);
```

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

### Initialize CdxFile from file path

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/CdxFile.md

Opens a CDX file using a file system path. Ensure the file exists to avoid FileNotFoundException.

```csharp
using (var cdxFile = new CdxFile("contacts.cdx"))
{
    var tagNames = cdxFile.TagNames;
    var index = cdxFile.GetIndex("CONTACT_ID");
}
```

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

### GetDecimal C# Example

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Retrieves the value of the specified column as a decimal.

```csharp
var decimalValue = reader.GetDecimal(1);
```

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

### Initialize DbfDbConnection with parameters

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbConnection.md

Instantiate the connection by providing the data source and server version directly.

```csharp
var connection = new DbfDbConnection("LocalDBF", "1.0");
connection.ConnectionString = "Folder=./data";
connection.Open();
```

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

### ConnectionString

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbConnection.md

Property to get or set the connection string for the DBF data source.

```APIDOC
## ConnectionString

### Description
The connection string containing the folder path and configuration options. It is parsed via DbfDbConnectionStringBuilder.

### Type
string
```

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

### Run index query benchmarks

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/test/DbfDataReader.Benchmarks/README.md

Execute benchmarks comparing performance with and without index usage for 2.x versions.

```bash
dotnet run -c Release --project test/DbfDataReader.Benchmarks -- --filter "*IndexQueryBenchmarks*" --job short
```

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

### GetFieldType C# Example

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Retrieves the .NET type of the column at the specified zero-based index.

```csharp
var type = reader.GetFieldType(0);
```

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

### Initialize DbfDbConnection with connection string

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/configuration.md

Setting the connection string on a DbfDbConnection instance and opening it.

```csharp
var connection = new DbfDbConnection();
connection.ConnectionString = "Folder=./data;SkipDeletedRecords=false;UseIndexes=true";
connection.Open();

var command = connection.CreateCommand();
command.CommandText = "select * from contacts.dbf";
```

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

### Retrieve string field value

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Get the value of a column as a string by its ordinal index.

```csharp
var stringValue = reader.GetString(0);
```

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

### DbfDbCommand.ExplainPlan()

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/README.md

Retrieves the execution plan for a SQL command to determine if an index seek or a full table scan is being performed.

```APIDOC
## DbfDbCommand.ExplainPlan()

### Description
Returns a string representation of the query execution plan, indicating whether the query uses an index seek or falls back to a full table scan.

### Usage
```csharp
var command = (DbfDbCommand)dbConnection.CreateCommand();
command.CommandText = "select * from setup.dbf where KEY_NAME = 'CONTACTS'";
Console.WriteLine(command.ExplainPlan());
```
```

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

### ExplainPlan usage

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbCommand.md

Generates a string representation of the query execution plan without reading data.

```csharp
command.CommandText = "select * from contacts.dbf where id = @id";
command.Parameters.AddWithValue("@id", 42);
Console.WriteLine(command.ExplainPlan());
// Output: "index seek (=) on tag 'ID'" or "table scan with filter"
```

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

### Initialize DbfDbConnection with default constructor

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbConnection.md

Instantiate the connection and set the connection string manually before opening.

```csharp
var connection = new DbfDbConnection();
connection.ConnectionString = "Folder=./data;SkipDeletedRecords=true";
connection.Open();
```

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

### Execute parameterized SQL commands

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/README.md

Demonstrates using parameters with DbfDbCommand.

```csharp
var command = (DbfDbCommand)dbConnection.CreateCommand();
command.CommandText = "select Point_ID from dbase_03.dbf where Point_ID = @id";
command.Parameters.AddWithValue("@id", "A1");
var value = command.ExecuteScalar();
```

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

### GetDataTypeName C# Example

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Retrieves the DBF-specific column type name for the column at the specified index.

```csharp
var typeName = reader.GetDataTypeName(0);
```

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

### Initialize DbfQuery

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfQuery.md

Create a query instance from a DbfTable. Direct instantiation is not supported.

```csharp
using (var table = new DbfTable("contacts.dbf"))
{
    var query = table.Query<Contact>();
}
```

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

### Retrieve 64-bit integer field value

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Get the value of a column as a 64-bit integer by its ordinal index.

```csharp
var longValue = reader.GetInt64(0);
```

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

### Initialize and Read DbfRecord

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfRecord.md

Create a new record instance tied to a table and iterate through rows.

```csharp
var table = new DbfTable("file.dbf");
var record = new DbfRecord(table);

while (table.Read(record))
{
    var isDeleted = record.IsDeleted;
    var stringValue = record.Values[0].ToString();
}
```

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

### Retrieve 32-bit integer field value

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Get the value of a column as a 32-bit integer by its ordinal index.

```csharp
var intValue = reader.GetInt32(3);
```

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

### DbfDataReader(string path, DbfDataReaderOptions options)

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Initializes a new instance of the DbfDataReader class using a file path and custom configuration options.

```APIDOC
## DbfDataReader(string path, DbfDataReaderOptions options)

### Description
Creates a new DbfDataReader for a file path with custom options.

### Parameters
- **path** (string) - Required - Path to the .dbf file to read
- **options** (DbfDataReaderOptions) - Required - Configuration options for reading behavior

### Returns
DbfDataReader instance

### Example
```csharp
var options = new DbfDataReaderOptions
{
    SkipDeletedRecords = true,
    Encoding = Encoding.UTF8,
    StringTrimming = StringTrimmingOption.Trim
};

using (var reader = new DbfDataReader("path/to/file.dbf", options))
{
    while (reader.Read())
    {
        var count = reader.FieldCount;
    }
}
```
```

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

### GetValue<T> C# Example

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Retrieves the value of the specified column with generic type conversion. Throws an Invalid cast exception if conversion fails.

```csharp
var typed = reader.GetValue<int>(0);
```

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

### Create and execute a command

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbConnection.md

Creates a DbfDbCommand instance to execute SQL text with parameters.

```csharp
var command = (DbfDbCommand)connection.CreateCommand();
command.CommandText = "select * from customers.dbf where id = @id";
command.Parameters.AddWithValue("@id", 42);
var result = command.ExecuteScalar();
```

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

### Initialize DbfTable from file path

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfTable.md

Opens a DBF file using a file path and iterates through its column metadata.

```csharp
using (var table = new DbfTable("path/to/file.dbf", Encoding.UTF8))
{
    foreach (var column in table.Columns)
    {
        Console.WriteLine($"{column.ColumnName}: {column.ColumnType}");
    }
}
```

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

### Initialize DbfTable with memo stream

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfTable.md

Opens a DBF file alongside a separate memo stream for processing records.

```csharp
using (var dbfStream = File.OpenRead("file.dbf"))
using (var memoStream = File.OpenRead("file.fpt"))
using (var table = new DbfTable(dbfStream, memoStream))
{
    while (table.Read(new DbfRecord(table)))
    {
        // process record
    }
}
```

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

### Initialize CdxFile from stream

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/CdxFile.md

Opens a CDX file from a seekable stream. Use the leaveOpen parameter to control stream lifecycle management.

```csharp
using (var stream = File.OpenRead("contacts.cdx"))
using (var cdxFile = new CdxFile(stream, Encoding.ASCII))
{
    var index = cdxFile.GetIndex("CONTACT_ID");
}
```

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

### Initialize DbfDataReader with file path

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Creates a reader instance using a file path and default configuration.

```csharp
using (var reader = new DbfDataReader("path/to/file.dbf"))
{
    while (reader.Read())
    {
        var value = reader.GetString(0);
    }
}
```

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

### CdxFile(string path, Encoding encoding = null)

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/CdxFile.md

Constructor to open a CDX file from a specified file path.

```APIDOC
## CdxFile(string path, Encoding encoding = null)

### Description
Opens a CDX file from a file path.

### Parameters
- **path** (string) - Required - Path to the .cdx file
- **encoding** (Encoding) - Optional - Character encoding for index keys (defaults to ASCII)

### Returns
CdxFile instance

### Throws
- FileNotFoundException: if file does not exist
- CdxException: if file is not a valid compound index
```

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

### Execute Simple SELECT Queries

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbCommand.md

Basic SQL SELECT statements for retrieving data from DBF files.

```sql
select * from contacts.dbf
select id, name, age from contacts.dbf
select id as customer_id, name as customer_name from contacts.dbf
```

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

### CdxFile(string path, Encoding encoding)

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/CdxFile.md

Initializes a new instance of the CdxFile class to read a CDX index file.

```APIDOC
## CdxFile Constructor

### Description
Initializes a new instance of the CdxFile class for a specified file path and character encoding.

### Signature
`public CdxFile(string path, Encoding encoding)`

### Parameters
- **path** (string) - The file system path to the .cdx file.
- **encoding** (Encoding) - The character encoding used by the associated DBF table.
```

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

### Bind parameters to DbfDbCommand

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbConnection.md

Demonstrates using named parameters in a SQL command with DbfDbCommand.

```csharp
var command = (DbfDbCommand)connection.CreateCommand();
command.CommandText = "select * from setup.dbf where KEY_NAME = @name";
command.Parameters.AddWithValue("@name", "CONTACTS");
var reader = command.ExecuteReader();
```

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

### Open a DBF connection

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbConnection.md

Sets the connection string and opens the connection. The target folder must exist.

```csharp
connection.ConnectionString = "Folder=./test/fixtures";
connection.Open();
```

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

### DbfDataReader(string path)

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Initializes a new instance of the DbfDataReader class using a file path with default options.

```APIDOC
## DbfDataReader(string path)

### Description
Creates a new DbfDataReader for a file path using default options.

### Parameters
- **path** (string) - Required - Path to the .dbf file to read

### Returns
DbfDataReader instance

### Example
```csharp
using (var reader = new DbfDataReader("path/to/file.dbf"))
{
    while (reader.Read())
    {
        var value = reader.GetString(0);
    }
}
```
```

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

### Supported SQL Syntax

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbCommand.md

Overview of supported SQL operations including SELECT, WHERE predicates, ORDER BY, row limits, and COUNT aggregates.

```APIDOC
## Supported SQL Syntax

### Simple SELECT
```sql
select * from contacts.dbf
select id, name, age from contacts.dbf
select id as customer_id, name as customer_name from contacts.dbf
```

### WHERE with Predicates
```sql
select * from contacts.dbf where age > 18
select * from contacts.dbf where name = 'John' and status = 'Active'
select * from contacts.dbf where status in ('Active', 'Pending')
select * from contacts.dbf where name like 'J%'
select * from contacts.dbf where email is not null
select * from contacts.dbf where age between 18 and 65
```

### ORDER BY
```sql
select * from contacts.dbf order by name
select * from contacts.dbf order by age desc, name asc
select top 10 * from contacts.dbf order by date_added desc
```

### Row Limits
```sql
select top 10 * from contacts.dbf
select * from contacts.dbf limit 5
```

### COUNT Aggregate
```sql
select count(*) from contacts.dbf
select count(*) from contacts.dbf where age > 18
```
```

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

### Initialize DbfColumn

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfColumn.md

Constructor for creating a column definition from a 32-byte DBF descriptor.

```csharp
public DbfColumn(ReadOnlySpan<byte> bytes, int start, int ordinal, Encoding encoding)
```

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

### Search and enumerate CDX index entries

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/types.md

Demonstrates searching for specific keys, performing a full scan, and counting entries in a CDX index.

```csharp
var index = cdxFile.GetIndex("CUSTOMER_ID");

// Exact search
var results = index.Search("CUST001");

// Full scan
foreach (var entry in index.EnumerateEntries())
{
    Console.WriteLine(entry.Key);
}

// Count without fetching entries
var total = index.Count();
```

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

### Define Parameter Types in C#

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbCommand.md

Demonstrates mapping various C# types to database parameters using AddWithValue.

```csharp
command.Parameters.AddWithValue("@intValue", 42);           // int
command.Parameters.AddWithValue("@stringValue", "text");    // string
command.Parameters.AddWithValue("@decimalValue", 19.99m);   // decimal
command.Parameters.AddWithValue("@dateValue", new DateTime(2023, 1, 1));  // DateTime
```

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

### Parameter Binding

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbCommand.md

Demonstrates how to use named and positional parameters with DbfDbCommand to safely execute queries.

```APIDOC
## Parameter Binding

### Named Parameters
```csharp
command.CommandText = "select * from contacts.dbf where id = @id and status = @status";
command.Parameters.AddWithValue("@id", 42);
command.Parameters.AddWithValue("@status", "Active");
```

### Positional Parameters
```csharp
command.CommandText = "select * from contacts.dbf where id = ? and status = ?";
command.Parameters.AddWithValue("id", 42);
command.Parameters.AddWithValue("status", "Active");
```
```

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

### Execute query and return list in C#

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfQuery.md

Executes the query and returns all results as a List. Ensure the query is fully defined before calling this method.

```csharp
var contacts = table.Query<Contact>()
    .Where(c => c.Age > 21)
    .OrderBy(c => c.Name)
    .ToList();
```

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

### Handle CdxException

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/CdxFile.md

Demonstrates catching a CdxException when attempting to open an invalid CDX file.

```csharp
try
{
    using (var cdxFile = new CdxFile("invalid.cdx"))
    {
    }
}
catch (CdxException ex)
{
    Console.WriteLine($"CDX error: {ex.Code} - {ex.Message}");
}
```

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

### Read and Search CDX Index

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/CdxFile.md

Shows how to open a CDX file, retrieve index tags, search for specific keys, and perform a full index scan.

```csharp
using DbfDataReader.Cdx;

var dbfPath = "path/to/contacts.dbf";
var cdxPath = "path/to/contacts.cdx";

using (var dbfTable = new DbfTable(dbfPath))
using (var cdxFile = new CdxFile(cdxPath, dbfTable.CurrentEncoding))
{
    var tagNames = cdxFile.TagNames;  // Get all available index tags
    
    var contactIdIndex = cdxFile.GetIndex("CONTACT_ID");
    
    // Search for a specific key
    foreach (var entry in contactIdIndex.Search("C0000000042"))
    {
        // entry.RecordIndex is zero-based for use with Seek
        dbfTable.Seek(entry.RecordIndex);
        
        var record = new DbfRecord(dbfTable);
        if (dbfTable.Read(record))
        {
            Console.WriteLine($"Found: {record.Values[0].GetValue()}");
        }
    }
    
    // Full index scan
    var count = contactIdIndex.Count();
    Console.WriteLine($"Total indexed entries: {count}");
}
```

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

### ToList()

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfQuery.md

Executes the query and returns all results as a list.

```APIDOC
## ToList()

### Description
Executes the query and returns all results as a list.

### Signature
`public List<T> ToList()`

### Returns
- **List<T>** - The list of query results
```

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

### CreateMemo(string path)

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfTable.md

Creates an appropriate memo file handler from a file path.

```APIDOC
## CreateMemo(string path)

### Description
Creates an appropriate memo file handler from a file path.

### Signature
`public DbfMemo CreateMemo(string path)`

### Parameters
- **path** (string) - Required - Path to memo file

### Returns
- **DbfMemo** - FoxPro, dBase3, or dBase4 memo handler
```

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

### Run cross-library benchmarks for specific versions

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/test/DbfDataReader.Benchmarks/README.md

Use the DbfDataReaderVersion environment variable to target specific library versions during benchmark execution.

```bash
DbfDataReaderVersion=1.1.0 dotnet run -c Release --project test/DbfDataReader.Benchmarks -- --filter "*DbfDataReaderBenchmarks*" --job short
DbfDataReaderVersion=2.1.0 dotnet run -c Release --project test/DbfDataReader.Benchmarks -- --filter "*DbfDataReaderBenchmarks*" --job short
```

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

### Supported SQL Syntax

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/QUICK_REFERENCE.md

Common SQL queries supported for interacting with DBF files.

```sql
select col1, col2 from file.dbf
select top 10 * from file.dbf
select * from file.dbf where col1 = @param
select * from file.dbf where col1 > 100 and col2 like 'A%'
select * from file.dbf order by col1 desc
select count(*) from file.dbf
```

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

### SQL Dialect and Execution

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbConnection.md

Describes the supported SQL syntax and parameter binding mechanisms for querying DBF files.

```APIDOC
## SQL Dialect

### Description
The library supports a subset of SQL for querying DBF files, including column selection, row limits, WHERE clauses, ORDER BY, and COUNT aggregates.

### Supported Statements
- Column selection with aliases: `select col1 as alias1, col2`
- Row limits: `select top 10 * from file.dbf` or `select * from file.dbf limit 5`
- WHERE clauses with predicates and named/positional parameters
- ORDER BY with multiple keys and ASC/DESC
- COUNT(*) aggregate with optimizations

### Parameter Binding
- Named parameters: `select * from file.dbf where id = @id`
- Positional parameters: `select * from file.dbf where id = ?`
```

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

### Connection String Configuration

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbConnection.md

Defines the available options for the connection string used to initialize the DbfDbConnection.

```APIDOC
## Connection String Options

### Description
The connection string is used to configure the DbfDbConnection. The syntax is `Folder=path;Option=value;...`.

### Parameters
- **Folder** (string) - Required - Path to the folder containing .dbf files
- **Encoding** (string) - Optional - Encoding web name (e.g., 'utf-8', 'ascii'). null uses DBF header language driver
- **SkipDeletedRecords** (boolean) - Optional - Whether to skip records marked as deleted (Default: true)
- **ReadFloatsAsDecimals** (boolean) - Optional - Whether to read float columns as decimals (Default: false)
- **StringTrimming** (string) - Optional - String trimming behavior: None, Trim, TrimStart, or TrimEnd (Default: Trim)
- **UseIndexes** (boolean) - Optional - Whether to use sidecar .cdx compound indexes automatically (Default: true)
```

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

### Initialize DbfDataReader with custom options

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Configures reading behavior such as skipping deleted records, character encoding, and string trimming.

```csharp
var options = new DbfDataReaderOptions
{
    SkipDeletedRecords = true,
    Encoding = Encoding.UTF8,
    StringTrimming = StringTrimmingOption.Trim
};

using (var reader = new DbfDataReader("path/to/file.dbf", options))
{
    while (reader.Read())
    {
        var count = reader.FieldCount;
    }
}
```

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

### Explain query execution plan in C#

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfQuery.md

Use this method to retrieve a string description of the query execution strategy without reading data. Useful for debugging performance.

```csharp
var plan = query.Where(c => c.Id == 42).ExplainPlan();
// Output: "index seek (=) on tag 'ID'" or "table scan with filter"
```

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

### Perform Batch Operations

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/configuration.md

Utilize DbfDataReader with SqlBulkCopy for efficient bulk data transfers.

```csharp
// Use DbfDataReader for bulk operations (SqlBulkCopy)
var options = new DbfDataReaderOptions { SkipDeletedRecords = true };
using (var reader = new DbfDataReader("file.dbf", options))
{
    using (var bulkCopy = new SqlBulkCopy(connection))
    {
        bulkCopy.DestinationTableName = "TargetTable";
        bulkCopy.WriteToServer(reader);  // Optimized stream
    }
}
```

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

### Read records by creating instances

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfTable.md

Read records directly into new instances until the end of the file is reached.

```csharp
DbfRecord record;
while ((record = table.ReadRecord()) != null)
{
    var value = record.Values[0].GetValue();
}
```

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

### CdxFile(Stream stream, Encoding encoding = null, bool leaveOpen = false)

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/CdxFile.md

Constructor to open a CDX file from a seekable stream.

```APIDOC
## CdxFile(Stream stream, Encoding encoding = null, bool leaveOpen = false)

### Description
Opens a CDX file from a stream.

### Parameters
- **stream** (Stream) - Required - Seekable stream containing CDX data
- **encoding** (Encoding) - Optional - Character encoding for index keys (defaults to ASCII)
- **leaveOpen** (bool) - Optional - Whether to leave stream open after close

### Returns
CdxFile instance

### Throws
- CdxException: if stream data is not a valid compound index
```

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

### Read records asynchronously by creating instances

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfTable.md

Asynchronously create and read records until the end of the file is reached.

```csharp
DbfRecord record;
while ((record = await table.ReadRecordAsync(cancellationToken)) != null)
{
    // process record
}
```

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

### Explain Query Execution Plan

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/QUICK_REFERENCE.md

Inspect the query plan to determine if an index seek or table scan is being performed.

```csharp
var plan = query.Where(c => c.Id == 42).ExplainPlan();
Console.WriteLine(plan);
// Output: "index seek (=) on tag 'ID'" or "table scan with filter"
```

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

### Project File Organization Structure

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/COMPLETION_REPORT.md

Visual representation of the project's documentation directory structure.

```text
/workspace/home/output/
├── README.md                          [7.4 KB] Main index
├── QUICK_REFERENCE.md                 [9.6 KB] Developer cheat sheet
├── API_INDEX.md                       [13 KB]  Alphabetical reference
├── types.md                           [12 KB]  Type definitions
├── configuration.md                   [8.5 KB] Configuration options
├── errors.md                          [11 KB]  Exception reference
├── DOCUMENTATION_SUMMARY.txt          [7.5 KB] Project summary
├── COMPLETION_REPORT.md               [This file]
└── api-reference/
    ├── DbfDataReader.md               [17 KB]  Reader class
    ├── DbfTable.md                    [12 KB]  Table access
    ├── DbfRecord.md                   [7.3 KB] Row data
    ├── DbfColumn.md                   [6 KB]   Column metadata
    ├── DbfQuery.md                    [11 KB]  LINQ queries
    ├── DbfDbConnection.md             [11 KB]  SQL connection
    ├── DbfDbCommand.md                [6.9 KB] SQL command
    └── CdxFile.md                     [7.4 KB] Compound indexes
```

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

### CreateMemo(Stream memoStream)

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfTable.md

Creates an appropriate memo file handler based on the DBF version.

```APIDOC
## CreateMemo(Stream memoStream)

### Description
Creates an appropriate memo file handler based on the DBF version.

### Parameters
- **memoStream** (Stream) - Required - Stream containing memo data

### Returns
- **DbfMemo** - FoxPro, dBase3, or dBase4 memo handler
```

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

### Initialize DbfDataReader with memo stream

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Supports reading DBF files that require an associated memo file stream.

```csharp
using (var dbfStream = new FileStream("file.dbf", FileMode.Open))
using (var memoStream = new FileStream("file.fpt", FileMode.Open))
using (var reader = new DbfDataReader(dbfStream, memoStream, new DbfDataReaderOptions()))
{
    while (reader.Read())
    {
        var memoData = reader.GetString(0);
    }
}
```

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

### Searching CDX Index Entries

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/types.md

Demonstrates iterating through search results and using the RecordIndex for seeking in a DBF table.

```csharp
foreach (var entry in index.Search("C0000000042"))
{
    dbfTable.Seek(entry.RecordIndex);  // Convert to zero-based
    // Read record at this position
}
```

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

### DbfTable(string path)

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfTable.md

Constructor to open a DBF file from a file path with automatic memo file detection.

```APIDOC
## DbfTable(string path)

### Description
Opens a DBF file from a file path with automatic memo file detection.

### Parameters
- **path** (string) - Required - Path to the .dbf file
- **encoding** (Encoding) - Optional - Text encoding (null uses DBF header language driver)
- **stringTrimming** (StringTrimmingOption) - Optional - String trimming behavior
- **readFloatsAsDecimals** (bool) - Optional - Whether to read float columns as decimals

### Returns
DbfTable instance

### Throws
FileNotFoundException if the file does not exist
```

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

### Handle CdxException

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/errors.md

Shows how to catch CdxException and inspect the specific error code to determine the cause of failure.

```csharp
try
{
    using (var cdxFile = new CdxFile("index.cdx"))
    {
        var index = cdxFile.GetIndex("KEY_NAME");
    }
}
catch (CdxException ex)
{
    Console.WriteLine($"CDX error: {ex.Code}");
    
    switch (ex.Code)
    {
        case CdxErrorCode.NotACompoundIndexHeader:
            Console.WriteLine("File is not a valid compound index");
            break;
        case CdxErrorCode.NodeChainTooLong:
            Console.WriteLine("Index tree is corrupted");
            break;
        default:
            Console.WriteLine("Index file cannot be read");
            break;
    }
}
```

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

### DbfDbConnection()

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbConnection.md

Constructor to create a new DbfDbConnection instance without initial properties.

```APIDOC
## DbfDbConnection()

### Description
Creates a new connection instance without setting DataSource or ServerVersion.

### Signature
`public DbfDbConnection()`

### Returns
- **DbfDbConnection** - A new instance of the connection.
```

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

### Set ConnectionString property

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbConnection.md

Configure the connection string to specify the folder path and operational flags.

```csharp
connection.ConnectionString = "Folder=./data;SkipDeletedRecords=false;UseIndexes=true";
```

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

### DbfDataReader(Stream stream, Stream memoStream, DbfDataReaderOptions options)

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Initializes a new instance of the DbfDataReader class from streams for both DBF and memo data.

```APIDOC
## DbfDataReader(Stream stream, Stream memoStream, DbfDataReaderOptions options)

### Description
Creates a new DbfDataReader from streams for both DBF and memo data.

### Parameters
- **stream** (Stream) - Required - Seekable stream containing DBF file data
- **memoStream** (Stream) - Required - Seekable stream containing memo file data
- **options** (DbfDataReaderOptions) - Required - Configuration options for reading behavior

### Returns
DbfDataReader instance

### Example
```csharp
using (var dbfStream = new FileStream("file.dbf", FileMode.Open))
using (var memoStream = new FileStream("file.fpt", FileMode.Open))
using (var reader = new DbfDataReader(dbfStream, memoStream, new DbfDataReaderOptions()))
{
    while (reader.Read())
    {
        var memoData = reader.GetString(0);
    }
}
```
```

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

### Handle FileNotFoundException

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/errors.md

Catching file access errors when a required .dbf or .cdx file is missing.

```csharp
try
{
    using (var table = new DbfTable("nonexistent.dbf"))
    {
    }
}
catch (FileNotFoundException)
{
    Console.WriteLine("DBF file not found");
}
```

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

### ExecuteScalar()

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbCommand.md

Executes the command and returns the first column of the first row.

```APIDOC
## ExecuteScalar()

### Description
Executes the command and returns the first column of the first row, or null if no rows are returned.

### Signature
`public override object ExecuteScalar()`

### Returns
- **object** - The value of the first column of the first row, or null.
```

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

### Bind Positional Parameters in C#

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbCommand.md

Uses ? placeholders for parameter binding in SQL commands.

```csharp
command.CommandText = "select * from contacts.dbf where id = ? and status = ?";
command.Parameters.AddWithValue("id", 42);
command.Parameters.AddWithValue("status", "Active");
```

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

### ToListAsync()

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfQuery.md

Asynchronously executes the query and returns all results.

```APIDOC
## ToListAsync(CancellationToken cancellationToken)

### Description
Asynchronously executes the query and returns all results.

### Signature
`public async Task<List<T>> ToListAsync(CancellationToken cancellationToken = default)`

### Parameters
- **cancellationToken** (CancellationToken) - Optional - Token to cancel the operation

### Returns
- **Task<List<T>>** - The list of query results
```

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

### Manage Index Usage

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/configuration.md

Verify query plans or force table scans to optimize data retrieval.

```csharp
// Queries automatically use .cdx indexes when available
// To verify: use ExplainPlan()
var plan = query.Where(c => c.Id == 42).ExplainPlan();

// Force table scan if indexes are slow
var results = query.WithoutIndexes().ToList();
```

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

### Implement Index Fallback for CDX Files

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/errors.md

Handle missing or corrupted index files by falling back to a full table scan when the index is unavailable.

```csharp
CdxFile cdxFile = null;
CdxIndex index = null;

try
{
    cdxFile = new CdxFile(cdxPath);
    index = cdxFile.GetIndex(tagName);
}
catch (FileNotFoundException)
{
    Console.WriteLine("Index file not found, using table scan");
}
catch (CdxException ex)
{
    Console.WriteLine($"Index error: {ex.Code}, using table scan");
}

if (index != null)
{
    // Use index
    foreach (var entry in index.Search(key))
    {
        table.Seek(entry.RecordIndex);
    }
}
else
{
    // Fallback to table scan with filter
}

cdxFile?.Close();
```

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

### DbfDbConnection(string dataSource, string serverVersion)

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbConnection.md

Constructor to create a new DbfDbConnection instance with specified DataSource and ServerVersion.

```APIDOC
## DbfDbConnection(string dataSource, string serverVersion)

### Description
Creates a new connection with pre-defined DataSource and ServerVersion properties.

### Parameters
- **dataSource** (string) - Required - The data source identifier.
- **serverVersion** (string) - Required - The server version string.

### Returns
- **DbfDbConnection** - A new instance of the connection.
```

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

### Access compound index files

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/QUICK_REFERENCE.md

Use CdxFile to search and navigate records based on a compound index.

```csharp
using (var dbfTable = new DbfTable("contacts.dbf"))
using (var cdxFile = new CdxFile("contacts.cdx"))
{
    var index = cdxFile.GetIndex("CONTACT_ID");
    foreach (var entry in index.Search("C0000000042"))
    {
        dbfTable.Seek(entry.RecordIndex);
        var record = new DbfRecord(dbfTable);
        dbfTable.Read(record);
    }
}
```

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

### First()

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfQuery.md

Returns the first result, throwing an exception if no rows match.

```APIDOC
## First()

### Description
Returns the first result. Throws if no rows match.

### Signature
`public T First()`

### Returns
- **T** - The first result

### Throws
- **InvalidOperationException** - If no rows match
```

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

### Handle KeyNotFoundException

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/errors.md

Catching errors when attempting to access a non-existent index tag.

```csharp
try
{
    var index = cdxFile.GetIndex("NONEXISTENT_TAG");
}
catch (KeyNotFoundException)
{
    Console.WriteLine("Index tag not found");
    var available = cdxFile.TagNames;
}
```

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

### Connection String Options

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/README.md

Configuration options available for the DbfDataReader connection string.

```APIDOC
## Connection String Options

### Parameters
- **Folder** (string) - Required - The folder containing the files to be queried.
- **Encoding** (string) - Optional - A valid encoding web name from System.Text.Encoding.
- **ReadFloatsAsDecimals** (boolean) - Optional - Whether to read floats as decimals. Default: false.
- **SkipDeletedRecords** (boolean) - Optional - Whether to skip deleted records. Default: true.
- **StringTrimming** (string) - Optional - String trimming behaviour: None, Trim, TrimStart, TrimEnd. Default: None.
- **UseIndexes** (boolean) - Optional - Whether to use sidecar .cdx compound indexes automatically. Default: true.
```

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

### Parameters

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbCommand.md

Collection of parameters for the command, supporting both named (@name) and positional (?) parameters.

```APIDOC
## Property: Parameters

### Description
Collection of parameters for the command. Supports named parameters (@name) and positional parameters (?).

### Type
DbfDbParameterCollection

### Example
```csharp
command.Parameters.AddWithValue("@id", 42);
command.Parameters.AddWithValue("@name", "John");
```
```

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

### Initialize DbfTable from stream

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfTable.md

Opens a DBF file from a seekable stream to access header information like record counts.

```csharp
using (var stream = new FileStream("file.dbf", FileMode.Open))
using (var table = new DbfTable(stream))
{
    var recordCount = table.Header.RecordCount;
}
```

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

### DbfTable(Stream stream, Stream memoStream)

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfTable.md

Constructor to open a DBF file from a stream with a separate memo stream.

```APIDOC
## DbfTable(Stream stream, Stream memoStream)

### Description
Opens a DBF file from a stream with a separate memo stream.

### Parameters
- **stream** (Stream) - Required - Seekable stream containing DBF data
- **memoStream** (Stream) - Optional - Seekable stream containing memo data
- **encoding** (Encoding) - Optional - Text encoding (null uses DBF header language driver)
- **stringTrimming** (StringTrimmingOption) - Optional - String trimming behavior
- **readFloatsAsDecimals** (bool) - Optional - Whether to read float columns as decimals
- **leaveOpen** (bool) - Optional - Whether to leave streams open after close

### Returns
DbfTable instance
```

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

### Define Model and Execute Query

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfQuery.md

Map DBF columns to a class and execute a filtered query.

```csharp
public class Contact
{
    public string ContactID { get; set; }
    public string Name { get; set; }
    public DateTime DateAdded { get; set; }
}

var contacts = table.Query<Contact>()
    .Where(c => c.DateAdded > DateTime.Now.AddYears(-1))
    .ToList();
```

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

### Importing DbfDataReader namespaces

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/QUICK_REFERENCE.md

Essential namespaces required for accessing the main API, index handling, and standard .NET data components.

```csharp
using DbfDataReader;              // Main API
using DbfDataReader.Cdx;          // Compound indexes
using System.Text;                 // Encoding
using System.Data.Common;          // DbCommand, DbConnection
using System.Threading.Tasks;      // Async support
```

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

### Perform a basic sequential read

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/README.md

Use DbfDataReader to iterate through records in a DBF file sequentially.

```csharp
using (var reader = new DbfDataReader("file.dbf"))
{
    while (reader.Read())
    {
        var value = reader.GetString(0);
    }
}
```

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

### Bind Named Parameters in C#

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbCommand.md

Uses @-prefixed placeholders for parameter binding in SQL commands.

```csharp
command.CommandText = "select * from contacts.dbf where id = @id and status = @status";
command.Parameters.AddWithValue("@id", 42);
command.Parameters.AddWithValue("@status", "Active");
```

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

### Configure DbfDbConnection string

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbConnection.md

Sets the connection string for the DbfDbConnection object using folder path and optional parameters.

```csharp
var connectionString = "Folder=./data;Encoding=utf-8;SkipDeletedRecords=false;UseIndexes=true";
connection.ConnectionString = connectionString;
```

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

### DbfDbConnection Methods

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/API_INDEX.md

Methods for managing database connections and executing queries.

```APIDOC
## DbfDbConnection Methods

- ChangeDatabase(string): Change folder path
- Close(): Close connection
- CreateCommand(): Create command
- Open(): Open connection
- Query<T>(string, object): Execute query
- QueryAsync<T>(string, object, CancellationToken): Execute query asynchronously
- QueryFirstOrDefault<T>(string, object): Get first result
```

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

### DbfDataReader(Stream stream, DbfDataReaderOptions options)

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDataReader.md

Initializes a new instance of the DbfDataReader class from a stream containing DBF data.

```APIDOC
## DbfDataReader(Stream stream, DbfDataReaderOptions options)

### Description
Creates a new DbfDataReader from a stream containing DBF data.

### Parameters
- **stream** (Stream) - Required - Seekable stream containing DBF file data
- **options** (DbfDataReaderOptions) - Required - Configuration options for reading behavior

### Returns
DbfDataReader instance

### Example
```csharp
using (var fileStream = new FileStream("file.dbf", FileMode.Open))
using (var reader = new DbfDataReader(fileStream, new DbfDataReaderOptions()))
{
    while (reader.Read())
    {
        var value = reader.GetDecimal(1);
    }
}
```
```

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

### Implement Graceful Degradation for DBF File Access

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/errors.md

Use try-catch blocks to handle missing files or invalid formats, ensuring resources are properly disposed of in a finally block.

```csharp
DbfTable table = null;
try
{
    table = new DbfTable(path);
}
catch (FileNotFoundException)
{
    Console.WriteLine($"File not found: {path}");
    return;
}
catch (DbfFileFormatException)
{
    Console.WriteLine($"Invalid DBF format: {path}");
    return;
}

try
{
    var record = new DbfRecord(table);
    while (table.Read(record))
    {
        // process record
    }
}
finally
{
    table?.Close();
}
```

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

### Query data into objects

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/_autodocs/api-reference/DbfDbConnection.md

Executes a SQL query and maps the results to a list of objects.

```csharp
public class Contact { public int Id { get; set; } public string Name { get; set; } }

var contacts = connection.Query<Contact>(
    "select id, name from contacts.dbf where id > @minId",
    new { minId = 10 }
);
```

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

### Inspect DBF table and column information

Source: https://github.com/yellowfeather/dbfdatareader/blob/main/README.md

Open a DBF file using DbfTable to access header metadata and column definitions.

```csharp
var dbfPath = "path/file.dbf";
using (var dbfTable = new DbfTable(dbfPath, Encoding.UTF8))
{
    var header = dbfTable.Header;

    var versionDescription = header.VersionDescription;
    var hasMemo = dbfTable.Memo != null;
    var recordCount = header.RecordCount;

    foreach (var dbfColumn in dbfTable.Columns)
    {
        var name = dbfColumn.ColumnName;
        var columnType = dbfColumn.ColumnType;
        var length = dbfColumn.Length;
        var decimalCount = dbfColumn.DecimalCount;
    }
}
```
Tokens:
Raw