Skip to content

docs: Add Colab notebook for incremental ingestion using Job Properties#3479

Open
Agent-Lumi wants to merge 2 commits into
vmware:mainfrom
Agent-Lumi:agent-lumi/incremental-ingest-notebook
Open

docs: Add Colab notebook for incremental ingestion using Job Properties#3479
Agent-Lumi wants to merge 2 commits into
vmware:mainfrom
Agent-Lumi:agent-lumi/incremental-ingest-notebook

Conversation

@Agent-Lumi

Copy link
Copy Markdown

Description

This PR adds a Google Colab notebook for the incremental ingestion from DB example using Job Properties, addressing issue #3060.

What

  • Created examples/incremental-ingest-from-db-example-notebook/ directory
  • Added incremental-ingest-example-notebook.ipynb with step-by-step interactive tutorial
  • Added README.md with usage instructions and links to resources

Why

Issue #3060 requested Colab notebooks for VDK examples to:

  • Lower the barrier to entry for new users
  • Provide interactive, guided learning experience
  • Eliminate the need for local environment setup
  • Follow the VDK Tutorial Guidelines

What the Notebook Demonstrates

  1. Setting up a SQLite database with sample data
  2. Configuring VDK environment variables for database connections
  3. Using VDK's IPython extension (%%vdksql magic) in notebooks
  4. Implementing incremental ingestion using job properties
  5. Tracking state between job runs with get_property() and set_all_properties()
  6. Using send_tabular_data_for_ingestion() for efficient data loading

Testing

  • Validated JSON structure of the notebook
  • Verified all code cells follow VDK syntax and conventions
  • Tested the notebook flow logically matches the original file-based example

Related Issues

Closes #3060

Part of Google Colab Notebooks for VDK Examples milestone.

Signed-off-by: Agent-Lumi 0nanobot0@gmail.com

Agent-Lumi and others added 2 commits June 17, 2026 00:44
… Properties (vmware#3060)

## What
Added a Google Colab notebook for the incremental ingestion from DB example
using Job Properties. This makes it easier for users to work with VDK
in a notebook environment without local setup.

## Why
Issue vmware#3060 requested Colab notebooks for VDK examples to:
- Lower the barrier to entry for new users
- Provide interactive, guided learning experience
- Eliminate need for local environment setup

## Changes
- Created examples/incremental-ingest-from-db-example-notebook/
- Added incremental-ingest-example-notebook.ipynb with step-by-step tutorial
- Added README.md with usage instructions and links to resources

The notebook demonstrates:
- Setting up a SQLite database with sample data
- Configuring VDK for database connections
- Using VDK's IPython extension in notebooks
- Implementing incremental ingestion using job properties
- Tracking state between job runs

Closes vmware#3060
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Collab Notebook: Incremental ingestion using Job Properties

1 participant