javeme commented on code in PR #497: URL: https://github.com/apache/incubator-hugegraph-toolchain/pull/497#discussion_r1348444653
########## hugegraph-spark-connector/README.md: ########## @@ -0,0 +1,123 @@ +<!-- +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. +--> + +# HugeGraph Spark Connector + +## Configs + +### Client Configs + +| Params | Default Value | Description | +|----------------------|---------------|----------------------------------------------------------------------------------------------| +| `host` | `localhost` | Address of HugeGraphServer | +| `port` | `8080` | Port of HugeGraphServer | +| `graph` | `hugegraph` | Graph space name | +| `protocol` | `http` | Protocol for sending requests to the server, optional `http` or `https` | +| `username` | `null` | Username of the current graph when HugeGraphServer enables permission authentication | +| `token` | `null` | Token of the current graph when HugeGraphServer has enabled authorization authentication | +| `timeout` | `60` | Timeout (seconds) for inserting results to return | +| `max-conn` | `CPUS * 4` | The maximum number of HTTP connections between HugeClient and HugeGraphServer | +| `max-conn-per-route` | `CPUS * 2` | The maximum number of HTTP connections for each route between HugeClient and HugeGraphServer | +| `trust-store-file` | `null` | The client’s certificate file path when the request protocol is https | +| `trust-store-token` | `null` | The client's certificate password when the request protocol is https | + +### Graph Data Configs + +| Params | Default Value | Description | +|-------------------|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `date-type` | | Graph data type, must be `vertex` or `edge` | +| `label` | | Label to which the vertex/edge data to be imported belongs | +| `id` | | Specify a column as the id column of the vertex. When the vertex id policy is CUSTOMIZE, it is required; when the id policy is PRIMARY_KEY, it must be empty | +| `source-name` | | Select certain columns of the input source as the id column of source vertex. When the id policy of the source vertex is CUSTOMIZE, a certain column must be specified as the id column of the vertex; when the id policy of the source vertex is When PRIMARY_KEY, one or more columns must be specified for splicing the id of the generated vertex, that is, no matter which id strategy is used, this item is required | +| `target-name` | | Specify certain columns as the id columns of target vertex, similar to source | +| `selected-fields` | | Select some columns to insert, other unselected ones are not inserted, cannot exist at the same time as ignored | +| `ignored-fields` | | Ignore some columns so that they do not participate in insertion, cannot exist at the same time as selected | +| `batch-size` | `500` | The number of data items in each batch when importing data | + +### Common Configs + +| Params | Default Value | Description | +|-------------|---------------|---------------------------------------------------------------------------------| +| `delimiter` | `,` | Separator of `source-name`, `target-name`, `selected-fields` or `ignore-fields` | + +## Example Review Comment: prefer to put it at the beginning and rename to how to use, please outline what steps are required in total and which steps they are. ########## hugegraph-spark-connector/README.md: ########## @@ -0,0 +1,123 @@ +<!-- +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. +--> + +# HugeGraph Spark Connector + Review Comment: can we add a section to describe what the project is and in what scenarios it is used. -- 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]
