User Guide for Odoo Snowflake Connector

Odoo Snowflake Connector helps you connect Odoo with Snowflake and sync business data easily.
You can export data, create tables, and use them for analysis and reporting.

With this connector, you can manage Snowflake databases and tables directly from Odoo.
It also supports automatic synchronization, schema updates, and data filtering for better control.

Snowflake -> Python connector library is used to create connections in Snowflake

snowflake-snowpark-python -> Snowpark library is used to perform DataFrame based processing and advanced operations in Snowflake using Python

• Secure Snowflake connection settings
• Create and manage Snowflake databases
• Generate tables from Odoo models
• Flexible field and column mapping
• Additional data synchronization
• Schema migration support
• Domain based data filtering
• Automatic synchronization using cron jobs

Once you purchase the App from Webkul store, you will receive a link to download the module zip file.

Extract the files on your system once the download is complete. You will see a folder called ‘wk_snowflake_connector’.

Copy and paste this folder inside your Odoo Add-Ons path.

Now, open the Odoo Application and click on the Settings menu. Enable Developer Mode.

Go to the Application menu and click ‘Update Module List’.

Search for ‘wk_snowflake_connector’ and click ‘Activate’ to install the module.

Step 1: Configure Snowflake Connection

• Go to Snowflake connection settings and create a new connection.
• Select the authentication type as Password or Programmed Access Token (PAT).
• You can also set up a warehouse for connection if needed.
• If not configured, the system will automatically use the default warehouse.

Step 2: Enter Connection Details

• Enter your Snowflake account, username, password, or PAT, and warehouse details.
• Save and test connection; Once successful, your connection is ready to use.

Using PAT for Connection :

Using Password:

Step 3: Create a Snowflake Database

• Go to the Snowflake database section in Odoo and create a new database.
• The PUBLIC scheme will be used.

• After entering the details: Database Name, Connection Name

Step 4: Access the Tables Section

• Open the created database and click on the table icon.
• Here you can view existing tables or create new tables.

Step 5: Configure Tables

• Create a table by selecting the Odoo model as the data source.
• Columns are generated automatically from model fields and can be customized.
• You can edit column names, order, and data types as needed.
• This helps structure the data properly before sending it to Snowflake.

Step 6: Configure Table Logic (Relationship, Sync, Automation)

• You can define table relationships using Odoo relational fields.
  Primary and foreign keys help connect related tables and maintain structured data.
• Enable Sync Existing Data to update exported records when changes occur.
  This ensures data remains consistent and prevents duplicate records in Snowflake.
• You can also enable cron export to automate data synchronization.
  It runs in the background and updates Snowflake data at scheduled intervals.

Step 7: Apply Domain Filter

• Use domain filters to control which data is exported.
• You can set rules such as only exporting confirmed orders or active records.
• This ensures only necessary data is sent to Snowflake.

Step 8: Publish the Table

• Click the new button to create a table in Snowflake.
• After entering the details, you can click on the Publish button
• The system creates columns, keys, and table structures automatically.

Step 9: Change Table (Schema Update)

• Click “Alter Table” to change the table structure.
• You can add or remove columns based on model changes.
• The changes will appear in the pending migration status.
• This lets you review updates before applying them.

Step 10: Schema Migration

• After changing the table, click migrate to apply the schema changes to Snowflake.
• This updates the table structure on the Snowflake side.
• New columns are added, and deleted columns are updated.
• This keeps the two systems in sync

Step 11: Export Data

• Click export to sync Odoo data to Snowflake tables.
• New notes are inserted, and existing notes are updated.
• This makes the process fast and efficient.

Step 12: Data to sync

• New Notes: This will display the number of unsynced notes. On clicking this, you can see the details of the note
• Updated Notes: This will display the number of notes that have been changed in Odoo. On clicking this, you can see the details of the note

Step 13: Schedule Sync (Cron Configuration)

• Configure cron jobs for automatic synchronization.
• Set a time interval to run the export regularly.
• This keeps Snowflake data constantly updated.
• No manual work required after setup.

Step 14: Delete Table or Data

• Use the delete option to delete synchronized tables or data.
• This resets the sync and cleans the database.
• You can safely delete all notes when necessary.
• This is useful for resynchronizing data from scratch.

We hope this guide is useful for you! Please share your feedback in the comments below.

If you still have problems/questions, please create a ticket at UV Desk.

If you have further questions, contact us on our support email: [email protected]

Thank you for noticing!!