Skip to content

doc(QTDI-3156): Improve docs for CreateConnection service #1251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dmytro-sylaiev merged 5 commits into from
Jul 9, 2026
Merged

doc(QTDI-3156): Improve docs for CreateConnection service #1251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e551bdc
doc(QTDI-3156): Improve docs for CreateConnection service
dmytro-sylaiev Jul 9, 2026
13d83d7
doc(QTDI-3156): Improve doc formatting
dmytro-sylaiev Jul 9, 2026
54a5a06
doc(QTDI-3156): Improve wording
dmytro-sylaiev Jul 9, 2026
1f612ea
doc(QTDI-3156): Rephraze
dmytro-sylaiev Jul 9, 2026
f93fbdf
doc(QTDI-3156): Shorten the documentation line
dmytro-sylaiev Jul 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion ...t-api/src/main/java/org/talend/sdk/component/api/service/connection/CreateConnection.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@
@Target(METHOD)
@Retention(RUNTIME)
@Documentation("Mark an action works for creating runtime connection, returning a runtime connection object like jdbc connection if database family. "
+ "Its parameter MUST be a datastore. Datastore is configuration type annotated with @DataStore. "
+ "Its parameter MUST be a datastore (configuration type annotated with @DataStore) annotated with `@Option`. "
+ "The `value` parameter of `@Option` must match the runtime class constructor parameter name of the component configuration class. "
+ "The functionality is for the Studio only, studio will use the runtime connection object when use existed connection, and no effect for cloud platform.")
Comment thread
Copilot marked this conversation as resolved.
public @interface CreateConnection {

Expand Down
2 changes: 2 additions & 0 deletions documentation/src/main/antora/modules/ROOT/pages/creating-dataset-datastore.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,8 @@ public class SomeInputMapper implements Serializable {
}
----

NOTE: The `@Option` value String parameter in the `@CreateConnection` method should match the name of runtime class constructor parameter for the Configuration class

== How does the component server interact with datasets and datastores

The component server scans all configuration types and returns a configuration type index. This index can be used for the integration into the targeted platforms (Studio, web applications, and so on).
Expand Down
Loading