You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/app/docs/usetdbgraphqlquery/page.md
+26-27Lines changed: 26 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,81 +48,80 @@ media: []
48
48
The following options are supported via the main options object passed to useTDBGraphqlQuery
49
49
50
50
*`limit : number`
51
-
52
51
* Optional
53
52
* The initial state value for `limit`
53
+
54
54
*`start : number`
55
-
56
55
* Optional
57
56
* The initial state value for `start`
57
+
58
58
*`tableConfigObj: Object`
59
-
60
59
* Optional
61
60
* The table configuration object
61
+
62
62
*`hiddenColumns : Array`
63
-
64
63
* Optional
65
64
* The initial state object for `hiddenColumnsArr`
66
-
67
-
## Instance Properties
68
-
69
-
The following properties are available on the table instance returned from useTDBGraphqlQuery
70
-
65
+
66
+
## Instance Properties
67
+
68
+
The following properties are available on the table instance returned from useTDBGraphqlQuery
69
+
70
+
71
71
*`state.loading : Bool`
72
-
73
72
* This is the current `loading` value, located on the state, if true the hook is doing a server call
73
+
74
74
*`state.error: Object|Bool`
75
-
76
75
* This is the current error reporting object from the server, located on the state, the starting value is false
76
+
77
77
*`state.limit: Number`
78
-
79
78
* This is set the limit clause to select a limited number of records, The starting value is 10. Using the `changeLimits` function will change the status of this property
79
+
80
80
*`state.start:Number`
81
-
82
81
* This is the pagination start value, pagination allows returning only a portion, rather than the whole, result set. The start value is 0. Use the `changeLimits` function to change the status of this property
82
+
83
83
*`state.queryFilters:Object`
84
-
85
84
* This is the query filter status, this value is used to fill the filter value in the GraphQL query variables. Use the `setAdvancedFilters` or `changeFilters` functions to change the status of this property
85
+
86
86
*`state.queryOrders:Object`
87
-
88
87
* This is the query orderBy status. Use this value to fill the orderBy value in the graphql query variables. Use the `changeOrders` function to change the status of this property
88
+
89
89
*`state.orderBy:Array` - This is the table orderBy status, transform this value to create the queryOrders object. Use the `changeOrders` function to change the status of this property
90
90
91
91
*`state.filterBy:Array`
92
-
93
92
* This is the table filter status, transform this value to create the queryFilters object. Use the `changeFilters` function to change the status of this property
93
+
94
94
*`state.rowCount:Number`
95
-
96
95
* This is the current number of records loaded
96
+
97
97
*`state.documentResults:Array`
98
-
99
98
* The successful GraphQL query fetch result data
99
+
100
100
*`state.extractedData:Array`
101
-
102
101
* The successful GraphQL query fetch result data formatted for the table
102
+
103
103
*`state.hiddenColumnsArr:Array`
104
-
105
104
* Store the table hiddenColumns list. If a column's ID is contained in this array, it will be hidden using the `setHiddenColumns` function
* This function changes the `limit`, the `start` status, the `queryOrders`, and the `queryFilters` properties and calls the server with pagination, returning only a portion, rather than the whole, result.
* This function changes the `limit` and `start` status properties and calls the server with pagination, returning only a portion, rather than the whole, result.
111
+
112
112
*`changeOrders: Function(orderByArr:Array)`
113
-
114
113
* This function gets the graphqlTable orderByArr variable and transforms it in the GraphQL orderBy variables format.
115
114
* Set the `queryOrders` and `orderBy` properties status to call the server with the current `queryOrders` and `queryFilters` status
116
-
*`changeFilters: Function(filtersArr:Array)`
117
-
115
+
116
+
*`changeFilters: Function(filtersArr:Array)`
118
117
* This function gets the graphqlTable filtersArr variable and transforms it in the GraphQL filters variables format.
119
118
* Set the `queryFilters` and `filterBy` properties status to call the server with the current `queryFilters` and `queryOrders` status
119
+
120
120
*`setAdvancedFilters: Function(advfilter:Object)`
121
-
122
121
* This gets the advfilter in the GraphQL filters variables format
123
122
* Set the `queryFilters` reset the `filterBy` properties status to call the server with the current `queryFilters` and `queryOrders` status
Copy file name to clipboardExpand all lines: src/app/layout.tsx
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -27,10 +27,10 @@ const lexend = localFont({
27
27
28
28
exportconstmetadata: Metadata={
29
29
title: {
30
-
template: '%s - TerminusDB Documentation',
31
-
default: 'TerminusDB - Git-for-data graph database for model-based hierarchical records.',
30
+
template: '%s',
31
+
default: 'TerminusDB, a git-for-data graph and document database',
32
32
},
33
-
description: 'TerminusDB provides Semantic Document Graph Infrastructure; with a model-based, in-memory, and distributed graph database for hierarchical records with a git-for-data collaboration model at its heart.',
33
+
description: 'TerminusDB provides Semantic Document Graph Infrastructure; a model-based, in-memory, and distributed graph database with git-for-data collaboration',
0 commit comments