e04ed9c211
CF: Deploy Dev Docs / deploy (push) Has been cancelled
Sync Labels / build (push) Has been cancelled
tests / unit tests (macos-latest) (push) Has been cancelled
tests / unit tests (windows-latest) (push) Has been cancelled
tests / unit tests (ubuntu-latest) (push) Has been cancelled
81 lines
2.4 KiB
Markdown
81 lines
2.4 KiB
Markdown
---
|
|
title: "SQLite Source"
|
|
linkTitle: "Source"
|
|
type: docs
|
|
weight: 1
|
|
description: >
|
|
SQLite is a C-language library that implements a small, fast, self-contained,
|
|
high-reliability, full-featured, SQL database engine.
|
|
no_list: true
|
|
---
|
|
|
|
## About
|
|
|
|
[SQLite](https://sqlite.org/) is a software library that provides a relational
|
|
database management system. The lite in SQLite means lightweight in terms of
|
|
setup, database administration, and required resources.
|
|
|
|
SQLite has the following notable characteristics:
|
|
|
|
- Self-contained with no external dependencies
|
|
- Serverless - the SQLite library accesses its storage files directly
|
|
- Single database file that can be easily copied or moved
|
|
- Zero-configuration - no setup or administration needed
|
|
- Transactional with ACID properties
|
|
|
|
|
|
|
|
## Available Tools
|
|
|
|
{{< list-tools >}}
|
|
|
|
### Pre-built Configurations
|
|
|
|
- [SQLite using MCP](../../documentation/connect-to/ides/sqlite_mcp.md)
|
|
Connect your IDE to SQlite using Toolbox.
|
|
|
|
## Requirements
|
|
|
|
### Database File
|
|
|
|
You need a SQLite database file. This can be:
|
|
|
|
- An existing database file
|
|
- A path where a new database file should be created
|
|
- `:memory:` for an in-memory database
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
kind: source
|
|
name: my-sqlite-db
|
|
type: "sqlite"
|
|
database: "/path/to/database.db"
|
|
```
|
|
|
|
For an in-memory database:
|
|
|
|
```yaml
|
|
kind: source
|
|
name: my-sqlite-memory-db
|
|
type: "sqlite"
|
|
database: ":memory:"
|
|
```
|
|
|
|
## Reference
|
|
|
|
### Configuration Fields
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
|-----------|:--------:|:------------:|---------------------------------------------------------------------------------------------------------------------|
|
|
| type | string | true | Must be "sqlite". |
|
|
| database | string | true | Path to SQLite database file, or ":memory:" for an in-memory database. |
|
|
| sqlCommenter | boolean | false | Overrides the global `--sql-commenter` flag for this source. When set, it takes priority; when omitted, the global flag applies. |
|
|
|
|
### Connection Properties
|
|
|
|
SQLite connections are configured with these defaults for optimal performance:
|
|
|
|
- `MaxOpenConns`: 1 (SQLite only supports one writer at a time)
|
|
- `MaxIdleConns`: 1
|