\n $\"Lattice$ \n

\n\n# Lattice\n\nLattice is a JSON document store with automatic schema detection, SQL-like querying, and flexible indexing. It supports multiple database backends including SQLite, SQL Server, PostgreSQL, and MySQL, enabling both embedded single-node deployments and horizontally scalable distributed architectures.\n\n## Features\n\n- **Automatic Schema Detection**: Ingest JSON documents without defining structure upfront\n- **SQL-like Queries**: Familiar `WHERE field = 'value'` syntax\n- **Multi-Database Support**: SQLite, SQL Server, PostgreSQL, MySQL\n- **Horizontal Scaling**: Deploy multiple instances against a shared database backend\n- **Automatic Indexing**: Fields indexed by default with selective override\n- **Optional Schema Enforcement**: Add constraints at any time\n- **REST API**: Built-in HTTP server for remote access\n\n## Screenshots\n\n### Creating a Collection\n\n $\"Creating$ \n\nCreate collections with custom labels, tags, schema enforcement modes, and indexing options.\n\n### Adding a Document\n\n $\"Adding$ \n\nAdd JSON documents with optional names, labels, and key-value tags for metadata.\n\n### Searching Documents\n\n $\"Searching$ \n\nSearch documents by labels, tags, and SQL-like expressions on data properties.\n\n## Installation\n\n```bash\ndotnet add package Lattice.Core\n```\n\nFor the REST server:\n```bash\ndotnet add package Lattice.Server\n```\n\n## Quick Start\n\n### Using LatticeClient (Embedded)\n\n#### SQLite (Default)\n\n```csharp\nusing Lattice.Core;\n\n// Default SQLite configuration\nLatticeSettings settings = new LatticeSettings();\nsettings.Database.Type = DatabaseTypeEnum.Sqlite;\nsettings.Database.Filename = \"lattice.db\";\n\nusing LatticeClient client = new LatticeClient(settings);\n\n// Create a collection and add documents\nawait client.Collection.CreateAsync(\"users\");\nawait client.Document.CreateAsync(\"users\", new { name = \"Alice\", email = \"alice@example.com\" });\n```\n\n#### SQLite In-Memory\n\n```csharp\nusing Lattice.Core;\n\nLatticeSettings settings = new LatticeSettings\n{\n InMemory = true\n};\nsettings.Database.Type = DatabaseTypeEnum.Sqlite;\nsettings.Database.Filename = \"lattice.db\";\n\nusing LatticeClient client = new LatticeClient(settings);\n```\n\n#### SQL Server\n\n```csharp\nusing Lattice.Core;\nusing Lattice.Core.Repositories.SqlServer;\n\n// Option 1: Using individual parameters\nSqlServerRepository repo = new SqlServerRepository(\n server: \"localhost\",\n database: \"lattice\",\n username: \"sa\",\n password: \"YourPassword123!\",\n trustServerCertificate: true\n);\nrepo.InitializeRepository();\n\nLatticeSettings settings = new LatticeSettings();\nusing LatticeClient client = new LatticeClient(repo, settings);\n\n// Option 2: Using connection string\nSqlServerRepository repo = new SqlServerRepository(\n \"Server=localhost;Database=lattice;User Id=sa;Password=YourPassword123!;TrustServerCertificate=true;\"\n);\nrepo.InitializeRepository();\n\nusing LatticeClient client = new LatticeClient(repo, new LatticeSettings());\n```\n\n#### PostgreSQL\n\n```csharp\nusing Lattice.Core;\nusing Lattice.Core.Repositories.Postgresql;\n\n// Option 1: Using individual parameters\nPostgresqlRepository repo = new PostgresqlRepository(\n host: \"localhost\",\n database: \"lattice\",\n username: \"postgres\",\n password: \"YourPassword123!\",\n port: 5432\n);\nrepo.InitializeRepository();\n\nLatticeSettings settings = new LatticeSettings();\nusing LatticeClient client = new LatticeClient(repo, settings);\n\n// Option 2: Using connection string\nPostgresqlRepository repo = new PostgresqlRepository(\n \"Host=localhost;Port=5432;Database=lattice;Username=postgres;Password=YourPassword123!;Pooling=true;\"\n);\nrepo.InitializeRepository();\n\nusing LatticeClient client = new LatticeClient(repo, new LatticeSettings());\n```\n\n#### MySQL\n\n```csharp\nusing Lattice.Core;\nusing Lattice.Core.Repositories.Mysql;\n\n// Option 1: Using individual parameters\nMysqlRepository repo = new MysqlRepository(\n server: \"localhost\",\n database: \"lattice\",\n username: \"root\",\n password: \"YourPassword123!\",\n port: 3306\n);\nrepo.InitializeRepository();\n\nLatticeSettings settings = new LatticeSettings();\nusing LatticeClient client = new LatticeClient(repo, settings);\n\n// Option 2: Using connection string\nMysqlRepository repo = new MysqlRepository(\n \"Server=localhost;Port=3306;Database=lattice;User=root;Password=YourPassword123!;Pooling=true;\"\n);\nrepo.InitializeRepository();\n\nusing LatticeClient client = new LatticeClient(repo, new LatticeSettings());\n```\n\n### Using Lattice.Server (REST API)\n\nLattice.Server loads configuration from the `lattice.json` settings file and exposes a REST API.\n\n#### Starting the Server\n\n```bash\n# Use default settings file (lattice.json)\ndotnet run --project src/Lattice.Server\n\n# Use custom settings file\ndotnet run --project src/Lattice.Server -- mysettings.json\n```\n\n#### Configuration File Examples\n\n##### SQLite Configuration (lattice.json)\n\n```json\n{\n \"Logging\": {\n \"ConsoleLogging\": true,\n \"MinimumSeverity\": 1,\n \"LogFilename\": \"lattice.log\"\n },\n \"Rest\": {\n \"Hostname\": \"localhost\",\n \"Port\": 8000\n },\n \"Lattice\": {\n \"InMemory\": false,\n \"DefaultDocumentsDirectory\": \"./documents\",\n \"EnableLogging\": false,\n \"Database\": {\n \"Type\": \"Sqlite\",\n \"Filename\": \"lattice.db\"\n }\n }\n}\n```\n\n##### SQL Server Configuration\n\n```json\n{\n \"Logging\": {\n \"ConsoleLogging\": true,\n \"MinimumSeverity\": 1,\n \"LogFilename\": \"lattice.log\"\n },\n \"Rest\": {\n \"Hostname\": \"0.0.0.0\",\n \"Port\": 8000\n },\n \"Lattice\": {\n \"DefaultDocumentsDirectory\": \"./documents\",\n \"EnableLogging\": false,\n \"Database\": {\n \"Type\": \"SqlServer\",\n \"Hostname\": \"localhost\",\n \"Port\": 1433,\n \"DatabaseName\": \"lattice\",\n \"Username\": \"sa\",\n \"Password\": \"YourPassword123!\"\n }\n }\n}\n```\n\n##### PostgreSQL Configuration\n\n```json\n{\n \"Logging\": {\n \"ConsoleLogging\": true,\n \"MinimumSeverity\": 1,\n \"LogFilename\": \"lattice.log\"\n },\n \"Rest\": {\n \"Hostname\": \"0.0.0.0\",\n \"Port\": 8000\n },\n \"Lattice\": {\n \"DefaultDocumentsDirectory\": \"./documents\",\n \"EnableLogging\": false,\n \"Database\": {\n \"Type\": \"Postgres\",\n \"Hostname\": \"localhost\",\n \"Port\": 5432,\n \"DatabaseName\": \"lattice\",\n \"Username\": \"postgres\",\n \"Password\": \"YourPassword123!\"\n }\n }\n}\n```\n\n##### MySQL Configuration\n\n```json\n{\n \"Logging\": {\n \"ConsoleLogging\": true,\n \"MinimumSeverity\": 1,\n \"LogFilename\": \"lattice.log\"\n },\n \"Rest\": {\n \"Hostname\": \"0.0.0.0\",\n \"Port\": 8000\n },\n \"Lattice\": {\n \"DefaultDocumentsDirectory\": \"./documents\",\n \"EnableLogging\": false,\n \"Database\": {\n \"Type\": \"Mysql\",\n \"Hostname\": \"localhost\",\n \"Port\": 3306,\n \"DatabaseName\": \"lattice\",\n \"Username\": \"root\",\n \"Password\": \"YourPassword123!\"\n }\n }\n}\n```\n\n## Horizontal Scaling\n\nWith SQL Server, PostgreSQL, or MySQL backends, multiple Lattice instances can share a common database, enabling horizontal scaling:\n\n```\n ┌─────────────────┐\n │ Load Balancer │\n └────────┬────────┘\n │\n ┌───────────────────┼───────────────────┐\n │ │ │\n ▼ ▼ ▼\n┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐\n│ Lattice.Server │ │ Lattice.Server │ │ Lattice.Server │\n│ Instance 1 │ │ Instance 2 │ │ Instance 3 │\n└────────┬────────┘ └────────┬────────┘ └────────┬────────┘\n │ │ │\n └───────────────────┼───────────────────┘\n │\n ▼\n ┌──────────────────┐\n │ Shared Database │\n │ (PostgreSQL / │\n │ SQL Server / │\n │ MySQL) │\n └──────────────────┘\n```\n\nEach instance connects to the same database, allowing:\n- **Load distribution** across multiple server instances\n- **High availability** through redundant instances\n- **Independent scaling** of application and database tiers\n\n## Core Operations\n\n### Collections\n\n```csharp\n// Create a collection\nawait client.Collection.CreateAsync(\"products\");\n\n// List collections\nList collections = await client.Collection.ListAsync();\n\n// Delete a collection\nawait client.Collection.DeleteAsync(\"products\");\n```\n\n### Documents\n\n```csharp\n// Create a document\nDocument doc = await client.Document.CreateAsync(\"products\", new\n{\n name = \"Widget\",\n price = 29.99,\n tags = new[] { \"hardware\", \"tools\" }\n});\n\n// Read a document\nDocument doc = await client.Document.ReadAsync(\"products\", documentId);\n\n// Update a document\nawait client.Document.UpdateAsync(\"products\", documentId, new\n{\n name = \"Widget Pro\",\n price = 39.99\n});\n\n// Delete a document\nawait client.Document.DeleteAsync(\"products\", documentId);\n```\n\n### Searching\n\n```csharp\n// Simple query\nSearchQuery query = new SearchQuery\n{\n CollectionGuid = collectionGuid,\n Conditions = \"name = 'Widget'\"\n};\nSearchResult result = await client.Search.SearchAsync(query);\n\n// Complex query with multiple conditions\nSearchQuery query = new SearchQuery\n{\n CollectionGuid = collectionGuid,\n Conditions = \"price > 20 AND price < 50 AND category = 'electronics'\"\n};\n\n// Query with pagination\nSearchQuery query = new SearchQuery\n{\n CollectionGuid = collectionGuid,\n Conditions = \"status = 'active'\",\n MaxResults = 100,\n StartIndex = 0\n};\n```\n\n### Supported Query Operators\n\n- `=` Equal\n- `!=` Not equal\n- `>` Greater than\n- `>=` Greater than or equal\n- `<` Less than\n- `<=` Less than or equal\n- `LIKE` Pattern matching (with `%` wildcard)\n- `IS NULL` Null check\n- `IS NOT NULL` Not null check\n\n## Project Structure\n\n```\nsrc/\n├── Lattice.Core/ # Core SDK library\n│ ├── Client/ # Client-facing API\n│ ├── Models/ # Data models\n│ ├── Repositories/ # Database implementations\n│ │ ├── Sqlite/\n│ │ ├── SqlServer/\n│ │ ├── Postgresql/\n│ │ └── Mysql/\n│ ├── Schema/ # Schema detection\n│ └── Search/ # Query parsing\n├── Lattice.Server/ # REST API server\n├── Test.Automated/ # Integration tests\n└── Test.Throughput/ # Performance tests\n```\n\n## Building and Testing\n\n```bash\n# Build the solution\ndotnet build\n\n# Run automated tests\ndotnet run --project src/Test.Automated\n\n# Run throughput tests\ndotnet run --project src/Test.Throughput\n```\n\n## Docker\n\nThe fastest way to get started with Lattice is using Docker Compose, which runs both the server and dashboard:\n\n```bash\n# Start both server and dashboard\ndocker-compose up -d\n\n# Access the dashboard at http://localhost:3000\n# Access the API directly at http://localhost:8000\n```\n\nThis starts:\n- **Lattice Server** on port 8000 with SQLite storage\n- **Lattice Dashboard** on port 3000 (proxies API requests to the server)\n\nData is persisted in Docker volumes (`lattice-data` and `lattice-documents`).\n\nFor detailed Docker configuration including external database backends, environment variables, and production deployment, see [DOCKER.md](DOCKER.md).\n\n## Database Backend Comparison\n\n| Feature | SQLite | SQL Server | PostgreSQL | MySQL |\n|---------|:------:|:----------:|:----------:|:-----:|\n| Embedded deployment | Yes | No | No | No |\n| Horizontal scaling | No | Yes | Yes | Yes |\n| Zero configuration | Yes | No | No | No |\n| Connection pooling | Limited | Yes | Yes | Yes |\n| In-memory mode | Yes | No | No | No |\n\n## License\n\nSee LICENSE file for details.\n\n## Attribution\n\nSpecial thanks to Particles icons created by Aranagraphics - Flaticon for the logo.","has_starred","hub_user","immutable_tags_settings",{"_233":11,"_234":235},"enabled","rules",[236],".*","is_automated","permissions",{"_240":21,"_241":11,"_242":11},"read","write","admin","user","storage_size",1369933027,"isOrg","reponame","tag","sha256:5f6cc1e18608fd568d7914c89ac4a32976d1c629d31d62250620331782b330b4","canDeleteTags","isHubSbxKitsEnabled","currentTab","tagAttestations","displaySecurityMetadata","showSbxLogoOverride","routes/_layout.layers.$namespace.$reponame.$tag.(images).($imageUrlDigest)._index",{"_27":28,"_189":-7,"_187":-7,"_188":-7,"_29":258,"_35":249,"_262":-7,"_263":11},{"_31":32,"_33":34,"_35":36,"_37":38,"_39":40,"_41":259,"_67":68,"_69":34,"_70":71,"_72":73,"_74":75,"_76":77,"_78":50,"_79":68,"_80":59,"_81":21},[260,261],{"_44":45,"_35":46,"_47":48,"_49":50,"_51":52,"_53":54,"_55":48,"_56":-5,"_57":38,"_58":59,"_60":-5},{"_44":62,"_35":63,"_47":48,"_49":64,"_51":65,"_53":54,"_55":48,"_56":-5,"_57":66,"_58":59,"_60":-5},"imageWithLayers","hasPermissionToViewRepoSettings","actionData","errors"]

jchristn77/lattice:v0.3.0