Skip to content

Dev guide connector features#12956

Merged
raunaqmorarka merged 2 commits intotrinodb:masterfrom
nineinchnick:dev-guide-connector-features
Jul 22, 2022
Merged

Dev guide connector features#12956
raunaqmorarka merged 2 commits intotrinodb:masterfrom
nineinchnick:dev-guide-connector-features

Conversation

@nineinchnick
Copy link
Copy Markdown
Member

Description

Update the developer guide to:

  • list all features a Trino plugin can implement
  • list all features a connector can implement
  • emphasize what's the minimum set of interfaces required to implement a read-only connector
  • mention that either one of ConnectorRecordSetProvider or ConnectorPageSourceProvider has to be implemented
  • mention ConnectorPageSinkProvider
  • describe how to deploy a plugin by extracting the zip file instead of copying jar files

Listing all features, even without describing them in detail, might help developers know what to look for in the interface classes' source code.

Is this change a fix, improvement, new feature, refactoring, or other?
improvement

Is this a change to the core query engine, a connector, client library, or the SPI interfaces? (be specific)
docs

How would you describe this change to a non-technical end user or system administrator?
n/a

Related issues, pull requests, and links

Documentation

( ) No documentation is needed.
(x) Sufficient documentation is included in this PR.
( ) Documentation PR is available with #prnumber.
( ) Documentation issue #issuenumber is filed, and can be handled later.

Release notes

(x) No release notes entries required.
( ) Release notes entries required with the following suggested text:

# Section
* Fix some things. ({issue}`issuenumber`)

@cla-bot cla-bot bot added the cla-signed label Jun 23, 2022
@github-actions github-actions bot added the docs label Jun 23, 2022
@nineinchnick nineinchnick added the no-release-notes This pull request does not require release notes entry label Jun 24, 2022
@nineinchnick nineinchnick force-pushed the dev-guide-connector-features branch from 621771d to e056593 Compare June 24, 2022 12:59
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can also mention Dynamic filter here as that is a type of pushdown that needs to be explicitly implemented by the connector

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is specifically about ConnectorMetadata. I'd describe dynamic filtering in a follow-up PR and then I can reference it here.

@MiguelWeezardo
Copy link
Copy Markdown
Member

I have nothing to add after @raunaqmorarka's comments

@nineinchnick nineinchnick force-pushed the dev-guide-connector-features branch from e056593 to 188cf2f Compare July 6, 2022 12:48
Copy link
Copy Markdown
Member

@raunaqmorarka raunaqmorarka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm % minor comment

@nineinchnick nineinchnick force-pushed the dev-guide-connector-features branch from 188cf2f to fcd5961 Compare July 6, 2022 13:06
@nineinchnick
Copy link
Copy Markdown
Member Author

@mosabua PTAL

@raunaqmorarka raunaqmorarka merged commit 9b7c1b9 into trinodb:master Jul 22, 2022
@nineinchnick nineinchnick deleted the dev-guide-connector-features branch July 22, 2022 12:23
@github-actions github-actions bot added this to the 391 milestone Jul 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed docs no-release-notes This pull request does not require release notes entry

Development

Successfully merging this pull request may close these issues.

3 participants