gianm commented on code in PR #13027:
URL: https://github.com/apache/druid/pull/13027#discussion_r1009976897


##########
docs/ingestion/native-batch-input-source.md:
##########
@@ -182,7 +182,7 @@ Sample specs:
 |uris|JSON array of URIs where S3 objects to be ingested are 
located.|None|`uris` or `prefixes` or `objects` must be set|
 |prefixes|JSON array of URI prefixes for the locations of S3 objects to be 
ingested. Empty objects starting with one of the given prefixes will be 
skipped.|None|`uris` or `prefixes` or `objects` must be set|
 |objects|JSON array of S3 Objects to be ingested.|None|`uris` or `prefixes` or 
`objects` must be set|
-|filter|A wildcard filter for files. See 
[here](http://commons.apache.org/proper/commons-io/apidocs/org/apache/commons/io/filefilter/WildcardFileFilter)
 for more information. Files matching the filter criteria are considered for 
ingestion. Files not matching the filter criteria are ignored.|None|no|
+|objectGlob|A wildcard filter for files. See 
[here](https://docs.oracle.com/javase/8/docs/api/java/nio/file/FileSystem.html#getPathMatcher-java.lang.String-)
 for more information. Files matching the filter criteria are considered for 
ingestion. Files not matching the filter criteria are ignored.|None|no|

Review Comment:
   IMO, this isn't clear enough for a new user to understand how it works. I 
suggest this instead:
   
   ```
   A glob for the object part of the S3 URI. In the URI 
`s3://foo/bar/file.json`, the glob is applied to `bar/file.json`.<br /><br 
/>The glob must match the entire object part, not just the filename. For 
example, the glob `*.json` does not match `s3://foo/bar/file.json`, because the 
object part is `bar/file.json`, and the`*` does not match the slash. To match 
all objects ending in `.json`, use `**.json` instead.<br /><br />For more 
information, refer to the documentation for 
[`FileSystem#getPathMatcher`](https://docs.oracle.com/javase/8/docs/api/java/nio/file/FileSystem.html#getPathMatcher-java.lang.String-).
   ```
   
   It would be formatted like this:
   
   > A glob for the object part of the S3 URI. In the URI 
`s3://foo/bar/file.json`, the glob is applied to `bar/file.json`.
   >
   > The glob must match the entire object part, not just the filename. For 
example, the glob `*.json` does not match `s3://foo/bar/file.json`, because the 
object part is `bar/file.json`, and the`*` does not match the slash. To match 
all objects ending in `.json`, use `**.json` instead.
   >
   > For more information, refer to the documentation for 
[`FileSystem#getPathMatcher`](https://docs.oracle.com/javase/8/docs/api/java/nio/file/FileSystem.html#getPathMatcher-java.lang.String-).



-- 
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.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to