-
Notifications
You must be signed in to change notification settings - Fork 9
Create new data loader page #319
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
nenharper
wants to merge
5
commits into
main
Choose a base branch
from
nenne/data-loader-page
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
d657346
Create new data loader page
nenharper bb2b401
Update versioned_docs/version-4.6/developers/applications/data-loader.md
nenharper 601ec04
Update versioned_docs/version-4.6/reference/applications/data-loader.md
nenharper 84b7385
Address comments
nenharper 65c7e24
fixing links
heskew File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
181 changes: 0 additions & 181 deletions
181
versioned_docs/version-4.6/developers/applications/data-loader.md
This file was deleted.
Oops, something went wrong.
134 changes: 134 additions & 0 deletions
134
versioned_docs/version-4.6/developers/applications/loading-data.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,134 @@ | ||
--- | ||
heskew marked this conversation as resolved.
Show resolved
Hide resolved
|
||
title: Loading Data | ||
--- | ||
|
||
# Loading Data | ||
|
||
Now that you’ve set up your first application, let’s bring it to life with some data. Applications are only as useful as the information they hold, and Harper makes it simple to seed your database with initial records, configuration values, or even test users, without needing to write a custom script. This is where the Data Loader plugin comes in. | ||
|
||
Think of the Data Loader as your shortcut for putting essential data in place from day one. Whether it’s a set of default settings, an admin user account, or sample data for development, the Data Loader ensures that when your application is deployed, it’s immediately usable. | ||
|
||
In this section, we’ll add a few dogs to our `Dog` table so our application starts with meaningful data. | ||
|
||
## Creating a Data File | ||
|
||
First, let’s make a `data` directory in our app and create a file called `dogs.json`: | ||
|
||
```json | ||
{ | ||
"database": "myapp", | ||
"table": "Dog", | ||
"records": [ | ||
{ | ||
"id": 1, | ||
"name": "Harper", | ||
"breed": "Labrador", | ||
"age": 3, | ||
"tricks": ["sit"] | ||
}, | ||
{ | ||
"id": 2, | ||
"name": "Balto", | ||
"breed": "Husky", | ||
"age": 5, | ||
"tricks": ["run", "pull sled"] | ||
} | ||
] | ||
} | ||
``` | ||
|
||
This file tells Harper: _“Insert these two records into the `Dog` table when this app runs.”_ | ||
|
||
## Connecting the Data Loader | ||
|
||
Next, let’s tell Harper to use this file when running the application. Open `config.yaml` in the root of your project and add: | ||
|
||
```yaml | ||
dataLoader: | ||
files: 'data/dogs.json' | ||
``` | ||
|
||
That’s it. Now the Data Loader knows where to look. | ||
|
||
## Running with Data | ||
|
||
Go ahead and start your app again: | ||
|
||
```bash | ||
harperdb dev . | ||
``` | ||
|
||
This time, when Harper runs, it will automatically read `dogs.json` and load the records into the Dog table. You don’t need to write any import scripts or SQL statements, it just works. | ||
|
||
You can confirm the data is there by hitting the endpoint you created earlier: | ||
|
||
```bash | ||
curl http://localhost:9926/Dog/ | ||
``` | ||
|
||
You should see both `Harper` and `Balto` returned as JSON. | ||
|
||
:::info | ||
💡 Notice the trailing `/` in the URL (`/Dog/`). This tells Harper to return all records in the table. Leaving it off would look for a single record instead. | ||
|
||
For more details on querying tables, resources, and records with the REST plugin, see the [REST reference docs](../../developers/rest). | ||
::: | ||
|
||
### Updating Records | ||
|
||
What happens if you change the data file? Let’s update Harper’s age from 3 to 4 in `dogs.json.` | ||
|
||
```json | ||
{ | ||
"id": 1, | ||
"name": "Harper", | ||
"breed": "Labrador", | ||
"age": 4, | ||
"tricks": ["sit"] | ||
} | ||
``` | ||
|
||
When you save the file, Harper will notice the change and reload. The next time you query the endpoint, Harper’s age will be updated. | ||
|
||
The Data Loader is designed to be safe and repeatable. If a record already exists, it will only update when the file is newer than the record. This means you can re-run deployments without worrying about duplicates. | ||
|
||
### Adding More Tables | ||
|
||
If your app grows and you want to seed more than just dogs, you can create additional files. For example, a `breeds.yaml` file: | ||
|
||
```yaml | ||
database: myapp | ||
table: Breed | ||
records: | ||
- id: 1 | ||
name: Labrador | ||
size: Large | ||
lifespan: 12 | ||
- id: 2 | ||
name: Husky | ||
size: Medium | ||
lifespan: 14 | ||
``` | ||
|
||
Then add it to your config: | ||
|
||
```yaml | ||
dataLoader: | ||
files: | ||
- 'data/dogs.json' | ||
- 'data/breeds.yaml' | ||
``` | ||
|
||
Harper will read both files and load them into their respective tables. | ||
|
||
## Key Takeaway | ||
|
||
With the Data Loader, your app doesn’t start empty. It starts ready to use. You define your schema, write a simple data file, and Harper takes care of loading it. This keeps your applications consistent across environments, safe to redeploy, and quick to get started with. | ||
|
||
In just a few steps, we’ve gone from an empty Dog table to a real application with data that’s instantly queryable. | ||
|
||
## Related Documentation | ||
|
||
- [Data Loader Reference](../../reference/applications/data-loader) – Complete configuration and format options. | ||
- [Bulk Operations](../operations-api/bulk-operations) - For loading data via the Operations API | ||
- [Plugins](../../reference/components/plugins) – For adding custom functionality to applications. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.