Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add showcase for Relation Function Class Mappings #849

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

add showcase for Relation Function Class Mappings #849

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0157fe4
add showcase for Relation Function class mappings
gs-rpant1729 Feb 7, 2025
2b01bbf
add showcase for Relation Function class mappings
gs-rpant1729 Feb 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
298 changes: 298 additions & 0 deletions showcases/data/End To End Examples/Relation Function Class Mapping/code.pure
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,298 @@
###Data
Data showcase::relationFunctionMapping::TestData
{
Relational
#{
default.firmTable:
'ID,LEGALNAME\n'+
'1,Firm X\n'+
'2,Firm A\n'+
'3,Firm B\n'+
'4,Firm C\n'+
'5,Firm D\n';

default.personTable:
'ID,FIRSTNAME,AGE,FIRMID,SALARY\n'+
'1,Peter,23,1,14.34\n'+
'2,John,30,1,72.40\n'+
'3,Jane,23,2,48.00\n'+
'4,Anthony,19,3,64.90\n'+
'5,Fabrice,45,4,19.29\n'+
'6,Oliver,26,4,42.34\n'+
'7,David,52,5,88.88\n';
}#
}


###Relational
Database showcase::relationFunctionMapping::store::Database
(
Table personTable
(
ID INTEGER PRIMARY KEY,
FIRSTNAME VARCHAR(100),
AGE INTEGER,
FIRMID INTEGER,
SALARY FLOAT
)
Table firmTable
(
ID INTEGER PRIMARY KEY,
LEGALNAME VARCHAR(100)
)
)


###Text
Text showcase::relationFunctionMapping::README
{
type: markdown;
content: 'This showcase demonstrates how to write Relation Function Class Mappings. \n\nThis allows you to map classes to functions returning a \'new\' TDS (Relation). Supported class properties can only be primitives \nhaving multiplicity 1 and get mapped to individual columns in the mapped relation.\n\nQueries can also use a mixture of Relational and Relation Function class mappings.\n\nYour relation expression can contain complex joins, aggregates and window columns, thus providing a more powerful alternative to \nRelational Store views.\n\nYou can execute the function tests to see how all of this works end-to-end. You can also generate plan for the functions and inspect \nthe generated SQL.';
}


###Pure
Class showcase::relationFunctionMapping::domain::Firm
{
legalName: String[1];
}

Class showcase::relationFunctionMapping::domain::Person
{
firstName: String[1];
age: Integer[1];
}

Class showcase::relationFunctionMapping::domain::ComplexPerson
{
firstName: String[1];
age: Integer[1];
salary: Float[1];
rank: Integer[1];
}

Association showcase::relationFunctionMapping::domain::Person_Firm
{
employees: showcase::relationFunctionMapping::domain::Person[*];
firm: showcase::relationFunctionMapping::domain::Firm[1];
}

function showcase::relationFunctionMapping::function::firmFunction(): meta::pure::metamodel::relation::Relation<meta::pure::metamodel::type::Any>[1]
{
#>{showcase::relationFunctionMapping::store::Database.firmTable}#->limit(10)->select(
~[
ID,
LEGALNAME
]
)
}

function showcase::relationFunctionMapping::function::personFunction(): meta::pure::metamodel::relation::Relation<meta::pure::metamodel::type::Any>[1]
{
#>{showcase::relationFunctionMapping::store::Database.personTable}#->filter(
x|$x.AGE > 15
)->limit(5)
}

function showcase::relationFunctionMapping::function::complexPersonFunction(): meta::pure::metamodel::relation::Relation<meta::pure::metamodel::type::Any>[1]
{
#>{showcase::relationFunctionMapping::store::Database.personTable}#->select(
~[
AGE,
FIRMID,
SALARY
]
)->join(
#>{showcase::relationFunctionMapping::store::Database.firmTable}#,
JoinKind.INNER,
{x,y|$x.FIRMID ==
$y.ID }
)->extend(
over(
~FIRMID,
~SALARY->ascending()
),
~[
RANK: {p,w,r|$p->rank(
$w,
$r
) }
]
)
}

function showcase::relationFunctionMapping::query::complexQuery(): meta::pure::tds::TabularDataSet[1]
{
showcase::relationFunctionMapping::domain::ComplexPerson.all()->project(
[
x|$x.age,
x|$x.rank,
x|$x.salary
],
[
'Age',
'Rank',
'Salary'
]
)->from(
showcase::relationFunctionMapping::mapping::ComplexMapping,
showcase::relationFunctionMapping::runtime::Runtime
)
}
{
test
(
showcase::relationFunctionMapping::store::Database: showcase::relationFunctionMapping::TestData;
test | complexQuery() => (JSON) '[\n {\n "Age": 23,\n "Rank": 1,\n "Salary": 14.34\n },\n {\n "Age": 30,\n "Rank": 2,\n "Salary": 72.4\n },\n {\n "Age": 23,\n "Rank": 1,\n "Salary": 48.0\n },\n {\n "Age": 19,\n "Rank": 1,\n "Salary": 64.9\n },\n {\n "Age": 45,\n "Rank": 1,\n "Salary": 19.29\n },\n {\n "Age": 26,\n "Rank": 2,\n "Salary": 42.34\n },\n {\n "Age": 52,\n "Rank": 1,\n "Salary": 88.88\n }\n]';
)
}

function showcase::relationFunctionMapping::query::simpleQuery(): meta::pure::tds::TabularDataSet[1]
{
showcase::relationFunctionMapping::domain::Firm.all()->project(
[
x|$x.legalName,
x|$x.employees.firstName,
x|$x.employees.age
],
[
'Legal Name',
'Employees/First Name',
'Employees/Age'
]
)->from(
showcase::relationFunctionMapping::mapping::SimpleMapping,
showcase::relationFunctionMapping::runtime::Runtime
)
}
{
test
(
showcase::relationFunctionMapping::store::Database: showcase::relationFunctionMapping::TestData;
test | simpleQuery() => (JSON) '[\n {\n "Legal Name": "Firm X",\n "Employees/First Name": "Peter",\n "Employees/Age": 23\n },\n {\n "Legal Name": "Firm X",\n "Employees/First Name": "John",\n "Employees/Age": 30\n },\n {\n "Legal Name": "Firm A",\n "Employees/First Name": "Jane",\n "Employees/Age": 23\n },\n {\n "Legal Name": "Firm B",\n "Employees/First Name": "Anthony",\n "Employees/Age": 19\n },\n {\n "Legal Name": "Firm C",\n "Employees/First Name": "Fabrice",\n "Employees/Age": 45\n },\n {\n "Legal Name": "Firm C",\n "Employees/First Name": "Oliver",\n "Employees/Age": 26\n },\n {\n "Legal Name": "Firm D",\n "Employees/First Name": "David",\n "Employees/Age": 52\n }\n]';
)
}

function showcase::relationFunctionMapping::query::mixedQuery(): meta::pure::tds::TabularDataSet[1]
{
showcase::relationFunctionMapping::domain::Person.all()->project(
[
x|$x.age,
x|$x.firstName,
x|$x.firm.legalName
],
[
'Age',
'First Name',
'Firm/Legal Name'
]
)->from(
showcase::relationFunctionMapping::mapping::MixedMapping,
showcase::relationFunctionMapping::runtime::Runtime
)
}
{
testSuite
(
showcase::relationFunctionMapping::store::Database: showcase::relationFunctionMapping::TestData;
test | mixedQuery() => (JSON) '[\n {\n "Age": 23,\n "First Name": "Peter",\n "Firm/Legal Name": "Firm X"\n },\n {\n "Age": 30,\n "First Name": "John",\n "Firm/Legal Name": "Firm X"\n },\n {\n "Age": 23,\n "First Name": "Jane",\n "Firm/Legal Name": "Firm A"\n },\n {\n "Age": 19,\n "First Name": "Anthony",\n "Firm/Legal Name": "Firm B"\n },\n {\n "Age": 45,\n "First Name": "Fabrice",\n "Firm/Legal Name": "Firm C"\n }\n]';
)
}


###Mapping
Mapping showcase::relationFunctionMapping::mapping::SimpleMapping
(
*showcase::relationFunctionMapping::domain::Person[person]: Relation
{
~func showcase::relationFunctionMapping::function::personFunction():Relation<Any>[1]
firstName: FIRSTNAME,
age: AGE,
+firmId: Integer[1]: FIRMID
}
*showcase::relationFunctionMapping::domain::Firm[firm]: Relation
{
~func showcase::relationFunctionMapping::function::firmFunction():Relation<Any>[1]
legalName: LEGALNAME,
+id: Integer[1]: ID
}

showcase::relationFunctionMapping::domain::Person_Firm: XStore
{
employees[firm, person]: $this.id ==
$that.firmId,
firm[person, firm]: $this.firmId ==
$that.id
}
)

Mapping showcase::relationFunctionMapping::mapping::ComplexMapping
(
*showcase::relationFunctionMapping::domain::ComplexPerson[person]: Relation
{
~func showcase::relationFunctionMapping::function::complexPersonFunction():Relation<Any>[1]
age: AGE,
salary: SALARY,
rank: RANK
}
)

Mapping showcase::relationFunctionMapping::mapping::MixedMapping
(
*showcase::relationFunctionMapping::domain::Person[person]: Relation
{
~func showcase::relationFunctionMapping::function::personFunction():Relation<Any>[1]
firstName: FIRSTNAME,
age: AGE,
+firmId: Integer[1]: FIRMID
}
*showcase::relationFunctionMapping::domain::Firm[firm]: Relational
{
~primaryKey
(
[showcase::relationFunctionMapping::store::Database]firmTable.ID
)
~mainTable [showcase::relationFunctionMapping::store::Database]firmTable
+id: Integer[1]: [showcase::relationFunctionMapping::store::Database]firmTable.ID,
legalName: [showcase::relationFunctionMapping::store::Database]firmTable.LEGALNAME
}

showcase::relationFunctionMapping::domain::Person_Firm: XStore
{
employees[firm, person]: $this.id ==
$that.firmId,
firm[person, firm]: $this.firmId ==
$that.id
}
)


###Connection
RelationalDatabaseConnection showcase::relationFunctionMapping::connection::Connection
{
store: showcase::relationFunctionMapping::store::Database;
type: H2;
specification: LocalH2
{
};
auth: DefaultH2;
}


###Runtime
Runtime showcase::relationFunctionMapping::runtime::Runtime
{
mappings:
[
showcase::relationFunctionMapping::mapping::SimpleMapping,
showcase::relationFunctionMapping::mapping::ComplexMapping,
showcase::relationFunctionMapping::mapping::MixedMapping
];
connections:
[
showcase::relationFunctionMapping::store::Database:
[
connection_1: showcase::relationFunctionMapping::connection::Connection
]
];
}
14 changes: 14 additions & 0 deletions showcases/data/End To End Examples/Relation Function Class Mapping/info.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
Title: Relation Function Class Mapping
Description: End-to-End example for writing Relation Function Class Mappings
---

This showcase demonstrates how to write Relation Function Class Mappings.

This allows you to map classes to functions returning a 'new' TDS (Relation). Supported class properties can only be primitives having multiplicity 1 and get mapped to individual columns in the mapped relation.

Queries can also use a mixture of Relational and Relation Function class mappings.

Your relation expression can contain complex joins, aggregates and window columns, thus providing a more powerful alternative to Relational Store views.

You can execute the function tests to see how all of this works end-to-end. You can also generate plan for the functions and inspect the generated SQL.
Loading