docs: dynamic datasource, model, repository, and controller #5630

hacksparrow · 2020-06-01T14:59:02Z

Describe how to create datasources, models, repositories, and
controllers at runtime. Part of addressing #4296.

First half addressed by #5591.

dhmlau

Some minor comments. I reviewed mostly from the readers' perspective. Please make sure we get at least one technical review/approval before we land. Thanks.

dhmlau · 2020-06-01T16:14:06Z

docs/site/Repositories.md

+
+#### 2. Using a Repository mixin
+
+Create a repository mixin with your customization as shown in the "


Suggestion: since it will be a link, i think we don't need the double quotes.

dhmlau · 2020-06-01T16:14:43Z

docs/site/Repositories.md

+```
+
+Note, the `app.repository()` method will be available only on `RepositoryMixin`
+apps


Application class?

Nah, it's not available on the Application class, it has to be composed with RepositoryMixin.

Right. I was thinking whether there's a better description than "RepositoryMix apps". I think it can be read it as Application class with RepositoryMixin?

raymondfeng · 2020-06-01T19:41:19Z

docs/site/Controllers.md

+and modify it according to your requirements.
+
+For details about `defineCrudRestController` and `CrudRestControllerOptions`,
+refer to the [@loopback/rest-crud API documentation](./apidocs/rest-crud.html).


Maybe we should mention Class factory to allow parameterized decorations per https://loopback.io/doc/en/lb4/core-tutorial-part10.html (Class factory to allow parameterized decorations).

Not really convinced. If I am understanding correctly, the content at the link describes a general programming pattern, not something specific to Controllers. If that's the case, we should avoid adding non-specific content to avoid noise.

The class factory is part of the programming model pattern and it's being asked by our users. It gives our users more control. The change is applying to Controllers.md and I don't think that's noise.

The change is applying to Controllers.md

Got the context, I thought it was about runtime controllers.

Added Class factory to allow parameterized decorations at an appropriate location.

docs/site/Model.md

bajtos

Nice! I agree with the general direction, let's improve the details now.

It would be great to have an overview of different ways how a model/repository/controller can be created (via lb4 repository, via lb4 rest-crud, dynamically at runtime). I was envisioning that Models.md/Controllers.md/etc. could have a short section explaining these different flavor. However, I understand such content may be out of scope of your current work, so I am fine with leaving this part for later.

bajtos · 2020-06-02T12:38:05Z

docs/site/Controllers.md

+and modify it according to your requirements.
+
+For details about `defineCrudRestController` and `CrudRestControllerOptions`,
+refer to the [@loopback/rest-crud API documentation](./apidocs/rest-crud.html).


bajtos · 2020-06-02T12:39:49Z

docs/site/DataSources.md

+
+A datasource can be created at runtime by creating an instance of
+`juggler.DataSource`. It requires a name for the datasource, the connector, and
+a connection url as shown below.


I find this misleading. The configuration object accepts any valid fields, e.g. host, port and user. The connection url is just one of the many valid ways how to configure a datasource.

Please clarify.

I think there is no need to repeat all details here, we should instead add a link to an existing documentation page showing different datasource configuration options.

Updated to make the statement more generic and linked to https://apidocs.strongloop.com/loopback-datasource-juggler/#datasource.

There's no LB4 doc with details about DataSource options. Ideally it should be on https://loopback.io/doc/en/lb4/DataSources.html.

There's no LB4 doc with details about DataSource options. Ideally it should be on https://loopback.io/doc/en/lb4/DataSources.html.

Perhaps you can open a new issue for that and add it to "Documentation improvements" epic #5113?

Opened yesterday - #5646.

docs/site/DataSources.md

docs/site/Model.md

bajtos · 2020-06-02T12:43:04Z

docs/site/Model.md

+Models can be created at runtime using the `defineModelClass()` helper function
+from the `@loopback/repository` class. It expects a base model to extend
+(typically `Model` or `Entity`), folowed by the model definition object as shown
+in the example below.


Can you please explain what is the second type parameter for?

docs/site/Repositories.md

docs/site/DataSources.md

bajtos · 2020-06-04T12:39:26Z

docs/site/DataSources.md

+
+A datasource can be created at runtime by creating an instance of
+`juggler.DataSource`. It requires a name for the datasource, the connector, and
+a connection url as shown below.


There's no LB4 doc with details about DataSource options. Ideally it should be on https://loopback.io/doc/en/lb4/DataSources.html.

Perhaps you can open a new issue for that and add it to "Documentation improvements" epic #5113?

bajtos

Almost there!

bajtos · 2020-06-04T12:42:38Z

docs/site/Model.md

-in the example below.
+(typically `Model` or `Entity`), followed by a `ModelDefinition` object as shown
+in the example below. The `ModelDefinition` object is an abstraction for
+specifying the various attributes of a LoopBack model.


Sorry for not being clear enough.

Can you please explain what is the second type parameter for?

In my comment ☝️, I was referring to the second item in the list of generic parameters for defineModelClass, i.e. the inline anonymous interface {id: number; title?: string}.

Now that I am looking at the example below again, I think may be good to show how bookDef is created too.

const bookDef = new ModelDefinition('Book') .addProperty('id', {type: 'number', id: true}) .addProperty('title', {type: 'string'}); const BookModel = // ...

I am afraid this comment is still not addressed.

As a user not familiar with defineModelClass, I don't understand what properties it should describe and why. Where is id and title coming from, why they have the particular type (number, string) and why title is optional while id is required?

I am looking for an explanation that

the interface is providing TypeScript description for the properties of the model we are defining

when omitted, the class will have only members inherited from the base model class, which typically means no properties

hacksparrow · 2020-06-04T12:59:22Z

@bajtos thanks for the feedback, applied them.

Describe how to create datasources, models, repositories, and controllers at runtime.

berlingoqc · 2020-08-19T22:03:21Z

Hi will there be a section about creating dynamic relation for repo with inclusion resolver ? Is this even possible ?

hacksparrow requested review from raymondfeng and bajtos June 1, 2020 14:59

dhmlau approved these changes Jun 1, 2020

View reviewed changes

dhmlau added the Docs label Jun 1, 2020

hacksparrow force-pushed the docs/dynamic-artifacts branch from d5a3a8e to dd4ead4 Compare June 1, 2020 16:25

raymondfeng reviewed Jun 1, 2020

View reviewed changes

docs/site/Model.md Show resolved Hide resolved

bajtos suggested changes Jun 2, 2020

View reviewed changes

bajtos reviewed Jun 4, 2020

View reviewed changes

bajtos suggested changes Jun 4, 2020

View reviewed changes

hacksparrow force-pushed the docs/dynamic-artifacts branch from b7094b4 to 3f416ec Compare June 4, 2020 12:58

hacksparrow force-pushed the docs/dynamic-artifacts branch from 453691d to 1fc720d Compare June 4, 2020 15:09

bajtos approved these changes Jun 4, 2020

View reviewed changes

hacksparrow force-pushed the docs/dynamic-artifacts branch 3 times, most recently from 572f9f4 to a446f43 Compare June 5, 2020 10:35

docs: dynamic datasource, model, repository, and controller

051d5b6

Describe how to create datasources, models, repositories, and controllers at runtime.

hacksparrow force-pushed the docs/dynamic-artifacts branch from a446f43 to 051d5b6 Compare June 5, 2020 10:36

raymondfeng approved these changes Jun 5, 2020

View reviewed changes

hacksparrow merged commit 2ec9bdf into master Jun 5, 2020

hacksparrow deleted the docs/dynamic-artifacts branch June 5, 2020 16:13

hacksparrow mentioned this pull request Jun 5, 2020

How to build models, repositories and controllers dynamically at runtime #4296

Closed

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: dynamic datasource, model, repository, and controller #5630

docs: dynamic datasource, model, repository, and controller #5630

hacksparrow commented Jun 1, 2020

dhmlau left a comment

dhmlau Jun 1, 2020

dhmlau Jun 1, 2020

hacksparrow Jun 1, 2020

dhmlau Jun 1, 2020

raymondfeng Jun 1, 2020

bajtos Jun 2, 2020

hacksparrow Jun 3, 2020

raymondfeng Jun 4, 2020

hacksparrow Jun 5, 2020

bajtos left a comment

bajtos Jun 2, 2020

bajtos Jun 2, 2020

hacksparrow Jun 3, 2020

bajtos Jun 4, 2020

hacksparrow Jun 4, 2020

bajtos Jun 2, 2020

bajtos Jun 4, 2020

bajtos left a comment

bajtos Jun 4, 2020

bajtos Jun 4, 2020

hacksparrow commented Jun 4, 2020

berlingoqc commented Aug 19, 2020


		#### 2. Using a Repository mixin

		Create a repository mixin with your customization as shown in the "

docs: dynamic datasource, model, repository, and controller #5630

docs: dynamic datasource, model, repository, and controller #5630

Conversation

hacksparrow commented Jun 1, 2020

dhmlau left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bajtos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bajtos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hacksparrow commented Jun 4, 2020

berlingoqc commented Aug 19, 2020