You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by GitBox <gi...@apache.org> on 2022/08/22 08:45:36 UTC
[GitHub] [incubator-devlake-website] mappjzc opened a new pull request, #171: docs: add plugin model docs
mappjzc opened a new pull request, #171:
URL: https://github.com/apache/incubator-devlake-website/pull/171
Add plugin model docs.
Nddtfjiang <zh...@merico.dev>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@devlake.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-devlake-website] klesh merged pull request #171: docs: add plugin model docs
Posted by GitBox <gi...@apache.org>.
klesh merged PR #171:
URL: https://github.com/apache/incubator-devlake-website/pull/171
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@devlake.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-devlake-website] klesh commented on a diff in pull request #171: docs: add plugin model docs
Posted by GitBox <gi...@apache.org>.
klesh commented on code in PR #171:
URL: https://github.com/apache/incubator-devlake-website/pull/171#discussion_r951442790
##########
docs/DataModels/DevLakeDomainLayerSchema.md:
##########
@@ -46,6 +46,21 @@ Tables that end with WIP are still under development.
<br/>
+## Get all domain layer model info.
+
+All domain layer models can be accessed by the following methods
+
+```golang
+import "github.com/apache/incubator-devlake/models/domainlayer/domaininfo"
+
+domaininfo := domaininfo.GetDomainTablesInfo()
+for _, table := range domaininfo {
+ // do something
+}
+```
+
+If you want to learn infomation about plugin model,please visit [PluginImplementation](https://devlake.apache.org/docs/DeveloperManuals/PluginImplementation)
Review Comment:
learn **more** about plugin **models**
##########
docs/DeveloperManuals/PluginImplementation.md:
##########
@@ -29,6 +29,7 @@ A plugin mainly consists of a collection of subtasks that can be executed by Dev
3. [PluginTask](https://github.com/apache/incubator-devlake/blob/main/plugins/core/plugin_task.go) enables a plugin to prepare data prior to subtask execution
4. [PluginApi](https://github.com/apache/incubator-devlake/blob/main/plugins/core/plugin_api.go) lets a plugin exposes some self-defined APIs
5. [Migratable](https://github.com/apache/incubator-devlake/blob/main/plugins/core/plugin_db_migration.go) is where a plugin manages its database migrations
+6. [PluginModel](https://github.com/apache/incubator-devlake/blob/main/plugins/core/plugin_model.go) allows other plugins to get the model information of all database tables of the current plugin through the GetTablesInfo() method.If you want to know more infomation about model of domain layer,please visit [DomainLayerSchema](https://devlake.apache.org/docs/DataModels/DevLakeDomainLayerSchema/)
Review Comment:
... If you need to access Domain Layer Models, ..
##########
docs/DataModels/DevLakeDomainLayerSchema.md:
##########
@@ -46,6 +46,21 @@ Tables that end with WIP are still under development.
<br/>
+## Get all domain layer model info.
+
+All domain layer models can be accessed by the following methods
Review Comment:
method, no `s`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@devlake.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org