Skip to main content

Quick Start Guide

Welcome to ERPL! This guide will help you get started with connecting DuckDB to your SAP ecosystem in just a few minutes.

Prerequisites​

Before you begin, ensure you have:

  • DuckDB 0.10.1 installed on your system
  • Access to an SAP ERP system with RFC enabled
  • A valid SAP user account with appropriate authorizations
  • Network connectivity to your SAP system

Installation​

Step 1: Install DuckDB​

If you haven't already, install DuckDB following the official installation guide.

Step 2: Install ERPL Extension​

Install the ERPL extension using DuckDB's extension system:

SET custom_extension_repository = 'http://get.erpl.io';
INSTALL 'erpl';
LOAD 'erpl';

Step 3: Verify Installation​

Confirm that ERPL is properly installed:

SELECT * FROM duckdb_extensions() WHERE extension_name = 'erpl';

You should see the ERPL extension listed.

Your First Connection​

Connect to SAP ERP​

Establish your first connection to an SAP ERP system:

SELECT sap_connect(
    host = 'your-sap-server.com',
    system_number = '00',
    client = '100',
    user = 'your-username',
    password = 'your-password'
);

List Available Tables​

Explore what's available in your SAP system:

SELECT * FROM sap_rfc_show_tables()
WHERE table_name LIKE '%KNA1%';

Query Your First Table​

Load customer master data from the KNA1 table:

SELECT 
    KUNNR as customer_number,
    NAME1 as customer_name,
    LAND1 as country,
    ORT01 as city
FROM sap_rfc_read_table('KNA1')
LIMIT 10;

Next Steps​

Congratulations! You've successfully connected DuckDB to SAP using ERPL. Here's what you can do next:

  1. Explore More Tables: Use sap_rfc_show_tables() to discover available data
  2. Read Documentation: Check out our Key Tasks for common use cases
  3. Join the Community: Connect with other users on GitHub

Troubleshooting​

Common Issues​

Connection Failed

  • Verify your SAP system details (host, system number, client)
  • Check network connectivity
  • Ensure your SAP user has RFC authorizations

Permission Denied

  • Contact your SAP administrator to grant RFC permissions
  • Verify your user account is active

Extension Not Found

  • Ensure you're using DuckDB 0.10.1
  • Check your internet connection for extension download

Getting Help​

If you encounter issues:

  1. Check our troubleshooting guide
  2. Search existing GitHub issues
  3. Contact our support team

What's Next?​

Now that you have ERPL running, explore these advanced topics: