useTDBDocuments hook
useTDBDocuments is the main hook to connect @terminusdb/terminusdb-documents-ui with the TerminusCMS server. To use it, pass it with an instance of @terminusdb/terminusdb-client
useTDBDocuments parameters
useTDBDocuments(woqlClient:WOQLClient)
woqlClient : WOQLClient- Required
- An WOQLClient instance with your connections settings
Instance Properties
state.loading : Bool- This is the current
loadingvalue, located on the state, if true the hook is doing a server call
- This is the current
state.error: Object|Bool- This is the current error reporting object from the server, located on the state, the starting value
state.perDocumentCount:Object|Bool- This is the current information about the number of documents, of every type, present in the database in a specific branch. The starting value is null, we need to call the
getDocumentsNumberfunction to fill this property status
- This is the current information about the number of documents, of every type, present in the database in a specific branch. The starting value is null, we need to call the
state.totalDocumentCount:Number|Bool- This is the current information about the total number of documents present in the database in a specific branch, the starting value is null, we need to call the
getDocumentsNumberfunction to fill this property status
- This is the current information about the total number of documents present in the database in a specific branch, the starting value is null, we need to call the
state.documentClasses:Array|Bool- This is the current information about the documents classes, the starting value is null, you need to call the
getDocumentNumbersor thegetDocumentClassesfunction to fill this property status
- This is the current information about the documents classes, the starting value is null, you need to call the
state.selectedDocument:Object|Bool- This is the current selected document object, the starting value is null, you need to call the
getSelectedDocumentfunction to fill this property status
- This is the current selected document object, the starting value is null, you need to call the
state.frame:Object|Bool- This is the current documents frames object, the starting value is false, you need to call the
getDocumentFramesfunction to fill this property status
- This is the current documents frames object, the starting value is false, you need to call the
state.documentTablesConfig:Object|Bool- This is the current document tables template, this property status stores the graphQL query for every document, the configuration for the tables, and the advanced search components. The starting value is null, you need to call the
getGraphqlTablesConfigfunction to fill this property status, after the call the status will either be the table config Object, or false if the call failed
- This is the current document tables template, this property status stores the graphQL query for every document, the configuration for the tables, and the advanced search components. The starting value is null, you need to call the
setError: Function(value:Object|Bool)- This function sets the error property status.
getDocumentClasses: Function()- This function calls the TerminusDB server to get the database classes list and sets the
documentClassesproperty with the server response.
- This function calls the TerminusDB server to get the database classes list and sets the
getDocumentNumbers: Function()- This function calls the TerminusDB server to get the database classes list and sets the
documentClassesproperty with the server response. It runs a query to get the total number of documents and the number of documents for type and fills theperDocumentCountand thetotalDocumentCount
- This function calls the TerminusDB server to get the database classes list and sets the
getDocumentFrames: Function()- This function gets the current database frames and sets the
framesstatus property
- This function gets the current database frames and sets the
getGraphqlTablesConfig: Function()- This function calls the TerminusDB server to get the GraphQL tables configuration and sets the
getGraphqlTablesConfigproperty status with the server response orerrorif there was an error in the call.
- This function calls the TerminusDB server to get the GraphQL tables configuration and sets the
createDocument: Function(jsonDocument:Object)- This function calls the server to create a new document in the current database
getSelectedDocument: Function(documentId:String)- Calls the server to get a document object and sets the
selectedDocumentstatus property with the response
- Calls the server to get a document object and sets the
deleteDocument: Function(documentId:String)- Calls the server to delete a document
updateDocument: Function(jsonDocument:Object)- Calls the server to update a document
getDocumentById: Function(documentId:String)- Calls the server to get a document object and return it
View the useTDBDocuments component integrated inside a dashboard here
useTDBDocuments example JS code to create a new document
For more detailed information take a look at the UI component pages - Document Classes Summary, Document GraphQL Table, Edit Documents, List Documents, New Documents, and View Documents.