|
| 1 | +# Data Loader |
| 2 | + |
| 3 | +The Data Loader is a built-in component that provides a reliable mechanism for loading data from JSON or YAML files into Harper tables as part of component deployment. This feature is particularly useful for ensuring specific records exist in your database when deploying components, such as seed data, configuration records, or initial application data. |
| 4 | + |
| 5 | +## Configuration |
| 6 | + |
| 7 | +To use the Data Loader, first specify your data files in the `config.yaml` in your component directory: |
| 8 | + |
| 9 | +```yaml |
| 10 | +dataLoader: |
| 11 | + files: 'data/*.json' |
| 12 | +``` |
| 13 | +
|
| 14 | +The Data Loader is an [Extension](../components/reference.md#extensions) and supports the standard `files` configuration option. |
| 15 | + |
| 16 | +## Data File Format |
| 17 | + |
| 18 | +Data files can be structured as either JSON or YAML files containing the records you want to load. Each data file must specify records for a single table - if you need to load data into multiple tables, create separate data files for each table. |
| 19 | + |
| 20 | +### Basic Example |
| 21 | + |
| 22 | +Create a data file in your component's data directory (one table per file): |
| 23 | + |
| 24 | +```json |
| 25 | +{ |
| 26 | + "database": "myapp", |
| 27 | + "table": "users", |
| 28 | + "records": [ |
| 29 | + { |
| 30 | + "id": 1, |
| 31 | + "username": "admin", |
| 32 | + |
| 33 | + "role": "administrator" |
| 34 | + }, |
| 35 | + { |
| 36 | + "id": 2, |
| 37 | + "username": "user1", |
| 38 | + |
| 39 | + "role": "standard" |
| 40 | + } |
| 41 | + ] |
| 42 | +} |
| 43 | +``` |
| 44 | + |
| 45 | +### Multiple Tables |
| 46 | + |
| 47 | +To load data into multiple tables, create separate data files for each table: |
| 48 | + |
| 49 | +**users.json:** |
| 50 | +```json |
| 51 | +{ |
| 52 | + "database": "myapp", |
| 53 | + "table": "users", |
| 54 | + "records": [ |
| 55 | + { |
| 56 | + "id": 1, |
| 57 | + "username": "admin", |
| 58 | + |
| 59 | + } |
| 60 | + ] |
| 61 | +} |
| 62 | +``` |
| 63 | + |
| 64 | +**settings.yaml:** |
| 65 | +```yaml |
| 66 | +database: myapp |
| 67 | +table: settings |
| 68 | +records: |
| 69 | + - id: 1 |
| 70 | + setting_name: app_name |
| 71 | + setting_value: My Application |
| 72 | + - id: 2 |
| 73 | + setting_name: version |
| 74 | + setting_value: "1.0.0" |
| 75 | +``` |
| 76 | + |
| 77 | +## File Organization |
| 78 | + |
| 79 | +You can organize your data files in various ways: |
| 80 | + |
| 81 | +### Single File Pattern |
| 82 | +```yaml |
| 83 | +dataLoader: |
| 84 | + files: 'data/seed-data.json' |
| 85 | +``` |
| 86 | + |
| 87 | +### Multiple Files Pattern |
| 88 | +```yaml |
| 89 | +dataLoader: |
| 90 | + files: |
| 91 | + - 'data/users.json' |
| 92 | + - 'data/settings.yaml' |
| 93 | + - 'data/initial-products.json' |
| 94 | +``` |
| 95 | + |
| 96 | +### Glob Pattern |
| 97 | +```yaml |
| 98 | +dataLoader: |
| 99 | + files: 'data/**/*.{json,yaml,yml}' |
| 100 | +``` |
| 101 | + |
| 102 | +## Loading Behavior |
| 103 | + |
| 104 | +When Harper starts up with a component that includes the Data Loader: |
| 105 | + |
| 106 | +1. The Data Loader reads all specified data files (JSON or YAML) |
| 107 | +2. For each file, it validates that a single table is specified |
| 108 | +3. Records are inserted or updated based on timestamp comparison: |
| 109 | + - New records are inserted if they don't exist |
| 110 | + - Existing records are updated only if the data file's modification time is newer than the record's updated time |
| 111 | + - This ensures data files can be safely reloaded without overwriting newer changes |
| 112 | +4. If records with the same primary key already exist, updates occur only when the file is newer |
| 113 | + |
| 114 | +Note: While the Data Loader can create tables automatically by inferring the schema from the provided records, it's recommended to define your table schemas explicitly using the [graphqlSchema](../applications/defining-schemas.md) component for better control and type safety. |
| 115 | + |
| 116 | +## Best Practices |
| 117 | + |
| 118 | +1. **Define Schemas First**: While the Data Loader can infer schemas, it's strongly recommended to define your table schemas and relations explicitly using the [graphqlSchema](../applications/defining-schemas.md) component before loading data. This ensures proper data types, constraints, and relationships between tables. |
| 119 | + |
| 120 | +2. **One Table Per File**: Remember that each data file can only load records into a single table. Organize your files accordingly. |
| 121 | + |
| 122 | +3. **Idempotency**: Design your data files to be idempotent - they should be safe to load multiple times without creating duplicate or conflicting data. |
| 123 | + |
| 124 | +4. **Version Control**: Include your data files in version control to ensure consistency across deployments. |
| 125 | + |
| 126 | +5. **Environment-Specific Data**: Consider using different data files for different environments (development, staging, production). |
| 127 | + |
| 128 | +6. **Data Validation**: Ensure your data files are valid JSON or YAML and match your table schemas before deployment. |
| 129 | + |
| 130 | +7. **Sensitive Data**: Avoid including sensitive data like passwords or API keys directly in data files. Use environment variables or secure configuration management instead. |
| 131 | + |
| 132 | +## Example Component Structure |
| 133 | + |
| 134 | +``` |
| 135 | +my-component/ |
| 136 | +├── config.yaml |
| 137 | +├── data/ |
| 138 | +│ ├── users.json |
| 139 | +│ ├── roles.json |
| 140 | +│ └── settings.json |
| 141 | +├── schemas.graphql |
| 142 | +└── roles.yaml |
| 143 | +``` |
| 144 | +
|
| 145 | +With this structure, your `config.yaml` might look like: |
| 146 | +
|
| 147 | +```yaml |
| 148 | +# Load environment variables first |
| 149 | +loadEnv: |
| 150 | + files: '.env' |
| 151 | +
|
| 152 | +# Define schemas |
| 153 | +graphqlSchema: |
| 154 | + files: 'schemas.graphql' |
| 155 | +
|
| 156 | +# Define roles |
| 157 | +roles: |
| 158 | + files: 'roles.yaml' |
| 159 | +
|
| 160 | +# Load initial data |
| 161 | +dataLoader: |
| 162 | + files: 'data/*.json' |
| 163 | +
|
| 164 | +# Enable REST endpoints |
| 165 | +rest: true |
| 166 | +``` |
| 167 | + |
| 168 | +## Related Documentation |
| 169 | + |
| 170 | +- [Built-In Components](../components/built-in.md) |
| 171 | +- [Extensions](../components/reference.md#extensions) |
| 172 | +- [Bulk Operations](../operations-api/bulk-operations.md) - For loading data via the Operations API |
0 commit comments