Skip to content

Commit 5bc4179

Browse files
author
ActiveDbSoft
committed
Description in models
1 parent b4e4576 commit 5bc4179

10 files changed

+20
-0
lines changed

docs/Model/Condition.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Condition
22

3+
Defines a constraint for original query resultset values.
4+
35
## Properties
46
Name | Type | Description | Notes
57
------------ | ------------- | ------------- | -------------

docs/Model/ConditionGroup.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# ConditionGroup
22

3+
Group of conditions joined with the same boolean operator.
4+
35
## Properties
46
Name | Type | Description | Notes
57
------------ | ------------- | ------------- | -------------

docs/Model/HiddenColumn.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# HiddenColumn
22

3+
Instructs to exclude some columns of original query from the SELECT list of transformed query.
4+
35
## Properties
46
Name | Type | Description | Notes
57
------------ | ------------- | ------------- | -------------

docs/Model/Pagination.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Pagination
22

3+
Instructs to limit the number of rows in transformed query resultset taking limitations of original query into account. In other words, if original query contains row limitation clause, it will be wrapped into a derived table and additional row limitation clause will be added ontop.
4+
35
## Properties
46
Name | Type | Description | Notes
57
------------ | ------------- | ------------- | -------------

docs/Model/QueryColumn.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# QueryColumn
22

3+
Provides information about particular SQL query column
4+
35
## Properties
46
Name | Type | Description | Notes
57
------------ | ------------- | ------------- | -------------

docs/Model/Sorting.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Sorting
22

3+
Determines rows order in transformed query. If there aren't any sortings, the original query sorting is kept.
4+
35
## Properties
46
Name | Type | Description | Notes
57
------------ | ------------- | ------------- | -------------

docs/Model/SqlQuery.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# SqlQuery
22

3+
Information about SQL query and it's context.
4+
35
## Properties
46
Name | Type | Description | Notes
57
------------ | ------------- | ------------- | -------------

docs/Model/Totals.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Totals
22

3+
If any aggregations are defined there, the SELECT list of original query is replaced with the list of aggregations in transformed query. Filling aggregations is useful when you want to get totals for original query resultset.
4+
35
## Properties
46
Name | Type | Description | Notes
57
------------ | ------------- | ------------- | -------------

docs/Model/Transform.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Transform
22

3+
SQL transformation parameters and commands.
4+
35
## Properties
46
Name | Type | Description | Notes
57
------------ | ------------- | ------------- | -------------

docs/Model/TransformResult.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# TransformResult
22

3+
Returns transformed SQL text in case of successful transformation. Otherwise returns error message.
4+
35
## Properties
46
Name | Type | Description | Notes
57
------------ | ------------- | ------------- | -------------

0 commit comments

Comments
 (0)