Data Model
Overview
The add-in provides access to Suadeo data through a dynamic view model. Unlike traditional data providers that have predefined views, Suadeo allows you to query custom views that are defined in your Suadeo environment using SQL passthrough.
Key Features
- The add-in models Suadeo data as relational views, allowing you to write standard SQL SELECT queries to retrieve data.
- Views are dynamically queried using SQL passthrough - your SQL query is sent directly to Suadeo for execution.
- Stored procedures allow you to execute operations such as creating schema definitions and managing OAuth authentication.
- Live connectivity means any data changes in your Suadeo environment are immediately reflected when querying.
Dynamic View Model
Suadeo uses a SQL passthrough approach where you write SQL queries that are executed directly against your Suadeo data. The add-in sends your SQL query to the Suadeo API, which processes it and returns the results.
To work with Suadeo data:
- Connect to Suadeo using OAuth authentication
- Write SQL SELECT queries to retrieve data from your views
- The add-in passes your SQL query to Suadeo for server-side execution
- Results are returned and can be consumed like any relational database query
Views
Your Suadeo environment contains custom views with application-specific data. These views are accessed using standard SQL SELECT syntax. All views are read-only.
See Sample View Examples for examples of working with custom views.
Stored Procedures
Stored Procedures are function-like interfaces to Suadeo. The add-in provides stored procedures for common operations:
- CreateSchema - Generates a schema definition file (.rsd) for a specified view, useful for integration scenarios
- GetOAuthAccessToken - Manages OAuth authentication tokens for programmatic access
Working with Dynamic Views
Since Suadeo uses SQL passthrough, you have flexibility in how you query data:
Direct SQL Approach: Write SQL queries directly against your views. The query is sent to Suadeo for execution:
-- Query a view with filters SELECT * FROM MyView WHERE Status = 'Active' -- Join multiple views SELECT a.Column1, b.Column2 FROM ViewA a INNER JOIN ViewB b ON a.Id = b.ParentId -- Use aggregations SELECT Category, COUNT(*) as Total FROM MyView GROUP BY Category
Schema File Approach: Use the CreateSchema stored procedure to generate reusable schema definition files for specific views:
EXEC CreateSchema TableName='MyView', FileName='C:\Schemas\MyView.rsd'
This creates an RSD file that documents the view structure and can be deployed with your application for consistent access.
SQL Passthrough
The add-in sends your SQL queries directly to Suadeo for execution. This means:
- Complex queries, joins, and aggregations are processed server-side by Suadeo
- Query performance depends on Suadeo's SQL engine capabilities
- You can use SQL features and functions supported by Suadeo
- The specific tables, views, and columns available depend on your Suadeo environment configuration