leonardBang commented on a change in pull request #12283:
URL: https://github.com/apache/flink/pull/12283#discussion_r429903878
##########
File path: docs/dev/table/connectors/filesystem.md
##########
@@ -0,0 +1,340 @@
+---
Review comment:
Please also add a filesystem.zh.md
##########
File path: docs/dev/table/connectors/filesystem.md
##########
@@ -0,0 +1,340 @@
+---
+title: "FileSystem Connector"
+nav-title: FileSystem Connector
+nav-parent_id: connectors
+nav-pos: 5
+---
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+This connector provides access to partitioned files in filesystems
+supported by the [Flink FileSystem abstraction]({{
site.baseurl}}/ops/filesystems/index.html).
+
+* This will be replaced by the TOC
+{:toc}
+
+The file system connector itself is included in Flink and does not require an
additional dependency.
+A corresponding format needs to be specified for reading and writing rows from
and to a file system.
+
+The file system connector allows for reading and writing from a local or
distributed filesystem. A filesystem can be defined as:
+
+<div class="codetabs" markdown="1">
+<div data-lang="DDL" markdown="1">
+{% highlight sql %}
+CREATE TABLE MyUserTable (
+ column_name1 INT,
+ column_name2 STRING,
+ ...
+ part_name1 INT,
+ part_name2 STRING
+) PARTITIONED BY (part_name1, part_name2) WITH (
+ 'connector' = 'filesystem', -- required: specify to connector type
+ 'path' = 'file:///path/to/whatever', -- required: path to a directory
+ 'format' = '...', -- required: file system connector
requires to specify a format,
+ -- Please refer to Table Formats
+ -- section for more details.s
+ 'partition.default-name' = '...', -- optional: default partition name in
case the dynamic partition
+ -- column value is null/empty string.
+
+ -- optional: the option to enable shuffle data by dynamic partition fields
in sink phase, this can greatly
+ -- reduce the number of file for filesystem sink but may lead data skew, the
default value is disabled.
+ 'sink.shuffle-by-partition.enable' = '...',
+ ...
+)
+{% endhighlight %}
+</div>
+</div>
+
+<span class="label label-danger">Attention</span> Make sure to include [Flink
File System specific dependencies]({{ site.baseurl
}}/ops/filesystems/index.html).
+
+<span class="label label-danger">Attention</span> File system sources for
streaming is still under development. In the future, the community will add
support for common streaming use cases, i.e., partition and directory
monitoring.
+
+## Partition Files
+
+Flink's file system partition support uses the standard hive format. However,
it does not require partitions to be pre-registered with a table catalog.
Partitions are discovered and inferred based on directory structure. For
example, a table partitioned based on the directory below would be inferred to
contain `datetime` and `hour` partitions.
+
+```
+path
+└── datetime=2019-08-25
+ └── hour=11
+ ├── part-0.parquet
+ ├── part-1.parquet
+ └── hour=12
+ ├── part-0.parquet
+└── datetime=2019-08-26
+ └── hour=6
+ ├── part-0.parquet
+```
+
+The file system table supports both partition inserting and overwrite
inserting. See [INSERT Statement]({{ site.baseurl }}/table/sql/insert.html).
When you insert overwrite to a partitioned table, only the corresponding
partition will be overwritten, not the entire table.
Review comment:
please check the URL，there are some url can not open properly
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
