Skip to content

[FLINK-30479][doc] Document flink-connector-files for local execution #21549

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

Closed
wants to merge 1 commit into from
Closed

[FLINK-30479][doc] Document flink-connector-files for local execution #21549

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions docs/content/docs/connectors/table/filesystem.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,18 @@ The file system connector itself is included in Flink and does not require an ad
The corresponding jar can be found in the Flink distribution inside the `/lib` directory.
A corresponding format needs to be specified for reading and writing rows from and to a file system.

NOTE: If you use the filesystem connector for [local execution]({{< ref "docs/dev/dataset/local_execution" >}}),
for e.g. running Flink job in your IDE, you will need to add dependency.

```xml
Copy link
Member Author

Choose a reason for hiding this comment

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

In the PR description, we mentioned why this does not use the sql_download_table shortcodes like {{< sql_download_table "files" >}}.

<dependency>
<groupId>org.apache.flink</groupId>
<artifactId>flink-connector-files</artifactId>
<version>{{< version >}}</version>
<scope>provided</scope>
</dependency>
```

The file system connector allows for reading and writing from a local or distributed filesystem. A filesystem table can be defined as:

```sql
Expand Down