databendlabs/databend

Feature: add sample directory with jupyter notebook

Open

#17,460 opened on Feb 15, 2025

View on GitHub
 (2 comments) (2 reactions) (0 assignees)Rust (880 forks)github user discovery
C-featuregood first issue

Repository metrics

Stars
 (9,314 stars)
PR merge metrics
 (Avg merge 4d 18h) (99 merged PRs in 30d)

Description

Overview

This proposal aims to streamline the onboarding process for new Databend users by providing a collection of interactive Jupyter notebooks.

Current Challenges

  • High entry barrier for users without Rust or SQL background
  • Complex setup process for new users
  • Limited interactive learning resources
  • Need for more structured hands-on examples

Proposed Solution

1. Environment Setup

  • Single command deployment
  • Cloud or local configuration

2. Learning Modules

  • Basic SQL operations
  • Data transformation
  • Advanced analytics
  • Best practices

3. Tutorial Structure

  • Progressive examples
  • Real-world scenarios
  • Integration guides

For example: https://github.com/treeverse/lakeFS-samples/tree/main/00_notebooks

Contributor guide

Research direction
Examine the lakeFS sample notebooks structure and integrate similar examples for Databend's SQL interface and features.
Tech stack
pythonrustsql
Domain
documentationcontentdeveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGitSQL
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80