-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #63 from Serpico1899/main
📝 add IRelatedRelation Type document
- Loading branch information
Showing
1 changed file
with
11 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,27 @@ | ||
# IRelatedRelation | ||
|
||
|
||
```ts | ||
export interface IRelatedRelation { | ||
/** | ||
* name of schema that this schema has relation with | ||
*/ | ||
schemaName: string; | ||
/** | ||
* name of the main relation related to this relation | ||
*/ | ||
mainRelationName: string; | ||
/** | ||
* type of the main relation related to this relation | ||
*/ | ||
mainRelationType: RelationDataType; | ||
/** | ||
* type of relation if equal to one: this schema record one object from other schema else | ||
* this schema record array of object from other schema | ||
*/ | ||
type: RelationDataType; | ||
/** | ||
* number of value that we want to keep | ||
*/ | ||
limit?: null | number; | ||
/** | ||
* sort : {field , order} - field of sort , and order of sort | ||
*/ | ||
sort?: { | ||
field: string; | ||
order: "asc" | "desc"; | ||
}; | ||
} | ||
``` | ||
|
||
the `IRelatedRelation` type has the following type : | ||
- [`RelationDataType`](./TRelation/RelationDataType.md) | ||
_if schema has relation with other schema and in SQL that we dont keep foriegn key._ | ||
<br> | ||
|
||
_store in OutRelation feature and usually the number of it greater thant of 50_ | ||
|
||
<h3>Types</h3> | ||
<pre> | ||
<code class="language-ts" style="padding: 0; margin-top: 12px; margin-top: -18px;"> | ||
<a href="./TRelation/RelationDataType.md" target="_blank" style="text-decoration: none; cursor:pointer">RelationDataType</a> | ||
</code> | ||
</pre> |