Guides¶
A guide takes you through one task from start to finish: what you need, the steps, and what you should see at the end. Find your task in the table below. If you are new to GraFlo, start with the Quick start and Creating a manifest; the guides assume you have a manifest or a graph to work with.
I want to...¶
| I want to... | Guide | Runnable example |
|---|---|---|
| Connect GraFlo to my database, with settings from environment variables, code or a YAML file | Database connections | Credentials outside the manifest (11) |
| Choose which database, graph or namespace my data is written to, or use one an administrator created | Graph namespace and schema | — |
| Find which fields identify my records before I write the manifest | Identity inference | Find what identifies a record (15) |
| Get a first manifest from a SQL database I already have | SQL schema inference | A graph from a PostgreSQL database (09) |
| Change my manifest: rename, add, re-key or remove a type or a property | Evolving a manifest | Version control for a manifest (22) |
| Read REST API addresses and credentials from environment variables | API env wiring | API sources from environment variables (12) |
| Load a large graph into TigerGraph quickly | TigerGraph bulk load | Bulk load into TigerGraph (13) |
| Move a graph from one database to another | Graph DB migration | A graph on disk, without a database (14) |
| Save a graph to files and load it back | Graph export and replay | A graph on disk, without a database (14) |
| Import only the parts of GraFlo I use, and know which layer my code belongs to | Importing and layering | — |
| Add support for a new database | Adding a database backend | — |
Tasks without a guide¶
These tasks are covered by a concept page or an example instead.
| I want to... | Read |
|---|---|
| Ingest messages from Kafka topics | Kafka connector |
| Look at a source before writing a manifest | Sampling and profiling |
| Link records that carry only an alternative identifier, such as a serial number | Vertex identity, Link by an alternative identifier (16) |
| Change the schema of a database that already holds data | Schema migration |
| Keep the history of a manifest and merge branches | Version control, Version control for a manifest (22) |
| Build a graph from an ontology and RDF data | A graph from an ontology and RDF data (10) |
What to read next¶
- Examples: runnable scripts, one question each.
- Concepts overview: the manifest and how ingestion works.
- Glossary: the terms used across these pages.