Skip to content
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.

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

Elasticsearch connector documentation fixes #12912

Closed
wants to merge 2 commits into from

Conversation

fastcatch
Copy link

Fixing points 2, 4 and 5 in #12880.

fastcatch added 2 commits June 6, 2019 15:26
in elasticsearch connector documentation
@facebook-github-bot
Copy link
Collaborator

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign up at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need the corporate CLA signed.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

@facebook-github-bot
Copy link
Collaborator

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

@wenleix
Copy link
Contributor

wenleix commented Jun 12, 2019

@zhenxiao : Can you help take a look at this PR? Thank you !

Copy link
Collaborator

@zhenxiao zhenxiao left a comment

Choose a reason for hiding this comment

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

thank you @fastcatch
generally is good. I left some comments

``long`` ``BIGINT``
``string`` ``VARCHAR``
``text`` ``VARCHAR``
(all others) (unsupported)
Copy link
Collaborator

Choose a reason for hiding this comment

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

s/all others/others/g

``ordinalPosition`` optional integer Ordinal position of the column.
===================== ========= ============== =============================

.. _field: https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-types.html
Copy link
Collaborator

Choose a reason for hiding this comment

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

prefer keep this link, as users might not be familiar with elasticsearch type

``jsonPath`` optional string Json path of Elasticsearch field.
``jsonType`` optional string Json type of Elasticsearch field.
``name`` required string Column name of Elasticsearch field.
``type`` required string Column type of Elasticsearch field (see second column of `data type mapping`_).
Copy link
Collaborator

Choose a reason for hiding this comment

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

prefer keep the field link, and point to type mapping

``jsonType`` optional string Json type of Elasticsearch field.
``name`` required string Column name of Elasticsearch field.
``type`` required string Column type of Elasticsearch field (see second column of `data type mapping`_).
``jsonPath`` required string Json path of Elasticsearch field (when in doubt set to the same as ``name``).
Copy link
Collaborator

Choose a reason for hiding this comment

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

could we use words other than 'when in doubt'? maybe default as name?

``name`` required string Column name of Elasticsearch field.
``type`` required string Column type of Elasticsearch field (see second column of `data type mapping`_).
``jsonPath`` required string Json path of Elasticsearch field (when in doubt set to the same as ``name``).
``jsonType`` required string Json type of Elasticsearch field (when in doubt set to the same as ``type``).
Copy link
Collaborator

Choose a reason for hiding this comment

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

same as jsonType

@stale
Copy link

stale bot commented Dec 10, 2019

This pull request has been automatically marked as stale because it has not had recent activity. If you'd still like this PR merged, please comment on the task, make sure you've addressed reviewer comments, and rebase on the latest master. Thank you for your contributions!

@stale stale bot added the stale label Dec 10, 2019
@stale stale bot closed this Dec 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants