AWS neptune-analytics documentation change
Summary
Reorganized and updated documentation for CSV data usage in Neptune Analytics, including restructuring sections, clarifying behavioral differences from Neptune Database, adding details on supported column types (Date, Datetime, Vector, Any), and listing limitations.
Security assessment
The changes are purely documentation restructuring and clarification of features, limitations, and data type support. There is no mention of security vulnerabilities, patches, or security incidents. The note about vector embeddings being 'non-atomic and unisolated' describes a transactional behavior, not a security flaw.
Diff
diff --git a/neptune-analytics/latest/userguide/using-CSV-data.md b/neptune-analytics/latest/userguide/using-CSV-data.md index 78c657e4a..84f4ec1b7 100644 --- a//neptune-analytics/latest/userguide/using-CSV-data.md +++ b//neptune-analytics/latest/userguide/using-CSV-data.md @@ -4,0 +5,2 @@ +Differences from Neptune DatabaseSupported column typesLimitations + @@ -9 +11 @@ Neptune Analytics, like [Neptune Database](https://docs.aws.amazon.com//neptune/ -###### Differences with Neptune csv (opencypher) format +## Behavioral differences from Neptune csv (opencypher) format @@ -13 +15 @@ Neptune Analytics, like [Neptune Database](https://docs.aws.amazon.com//neptune/ - * The `~id` (`:ID`) column in `edge` (`relationship`) files in `CSV` (`opencypher`) format are not supported. They are ignored if provided in any of the `edge` (`relationship`) files. + * The `~id` (`:ID`) column in `edge` (`relationship`) files in `CSV` (`opencypher`) format is not supported. It is ignored if provided in any of the `edge` (`relationship`) files. @@ -20,3 +22 @@ Neptune Analytics, like [Neptune Database](https://docs.aws.amazon.com//neptune/ - * Only explicitly provided labels are associated with the vertices. If the label provided is empty, the vertex would be added without a label. If a row contains just the vertex id without any labels or properties then the row is ignored, and no vertex is added. For more information about vertices, see [vertices](./query-openCypher-data-model.html#query-openCypher-data-model-vertices). - - * A new column type `Vector` is supported for associating embeddings with vertices. Since Neptune Analytics only supports one index type at this moment, the property name for embeddings is currently fixed to `embedding`. If the element type of the embeddings are not floating point (FP32), they will be typecasted to FP32. The embeddings in the `csv` files are optional when the vector index is enabled. This means that not every node needs to be associated with an embedding. If you want to set up a vector index for the graph, choose use `vector dimension` and then specify the number of dimensions for the vectors in the index. Note that the `dimension` must match the dimension of the embeddings in the vertex files. The changes to vector embeddings are non-atomic and unisolated (see [Vector index transaction support](./vector-index.html#vector-index-transaction-support)), that is they become durable and visible to other queries immediately upon write, unlike other properties. For more details of loading embeddings, refer to [vector-index](https://docs.aws.amazon.com//neptune-analytics/latest/userguide/vector-index.html). + * Only explicitly provided labels are associated with the vertices. If the label provided is empty, the vertex is added without a label. If a row contains just the vertex id without any labels or properties then the row is ignored, and no vertex is added. For more information about vertices, see [vertices](./query-openCypher-data-model.html#query-openCypher-data-model-vertices). @@ -29 +29,6 @@ Neptune Analytics, like [Neptune Database](https://docs.aws.amazon.com//neptune/ - * Unlike Neptune Database, a vertex identifier could appear just in edge files. Neptune Analytics allows loading just the edge data from files in Amazon S3, and running an algorithm over the data without needing to provide any additional vertex information. The edges are created between vertices with the given identifiers, and the vertices have no labels or properties unless any are provided in the vertex files. For more information on vertices and what they are, see [vertices](./query-openCypher-data-model.html#query-openCypher-data-model-vertices). + * Unlike Neptune Database, a vertex identifier can appear just in edge files. Neptune Analytics allows loading just the edge data from files in Amazon S3, and running an algorithm over the data without needing to provide any additional vertex information. The edges are created between vertices with the given identifiers, and the vertices have no labels or properties unless any are provided in the vertex files. For more information on vertices and what they are, see [vertices](./query-openCypher-data-model.html#query-openCypher-data-model-vertices). + + * Unlike Neptune Database, Neptune Analytics doesn't convert the `Date` type into `Datetime` type. + + + @@ -31 +36 @@ Neptune Analytics, like [Neptune Database](https://docs.aws.amazon.com//neptune/ - * Date column type is supported. The following date formats are supported: yyyy-MM-dd, yyyy-MM-dd[+|-]hhmm. To include time along with date, use the `Datetime` column type instead. Note that unlike Neptune Database, Neptune Analytics doesn't convert the date type into datetime Type. +## Supported column types @@ -33 +38,5 @@ Neptune Analytics, like [Neptune Database](https://docs.aws.amazon.com//neptune/ - * The datetime values can either be provided in the [XSD format](https://www.w3.org/TR/xmlschema-2/) or one of the following formats: +### Date and Datetime + +The `Date` column type is supported. The following date formats are supported: `yyyy-MM-dd`, `yyyy-MM-dd[+|-]hhmm`. To include time along with date, use the `Datetime` column type instead. + +The datetime values can either be provided in the [XSD format](https://www.w3.org/TR/xmlschema-2/) or one of the following formats: @@ -49 +57,0 @@ Neptune Analytics, like [Neptune Database](https://docs.aws.amazon.com//neptune/ - * Float and double values in scientific notation are currently not supported. Also, `Infinity`, `INF`, `-Infinity`, `-INF`, and `NaN` (`Not-a-number`) values are supported. @@ -51 +58,0 @@ Neptune Analytics, like [Neptune Database](https://docs.aws.amazon.com//neptune/ - * `Gzip` files are not supported. @@ -53 +59,0 @@ Neptune Analytics, like [Neptune Database](https://docs.aws.amazon.com//neptune/ - * The maximum length of the strings supported is smaller, and limited to 1,048,062 bytes. The limit would be lower for strings with unicode characters since some unicode characters are represented using multiple bytes. @@ -55 +61,7 @@ Neptune Analytics, like [Neptune Database](https://docs.aws.amazon.com//neptune/ - * `allowEmptyStrings` parameter is not supported. Empty string values ("") are not treated as null or missing value, and stored as a property value. +### Vector + +A new column type `Vector` is supported for associating embeddings with vertices. Since Neptune Analytics only supports one index type at this moment, the property name for embeddings is currently fixed to `embedding`. If the element type of the embeddings is not floating point (FP32), it is cast to FP32. The embeddings in the `csv` files are optional when the vector index is enabled. This means that not every node needs to be associated with an embedding. If you want to set up a vector index for the graph, choose the `vector dimension` and then specify the number of dimensions for the vectors in the index. The changes to vector embeddings are non-atomic and unisolated (see [Vector index transaction support](./vector-index.html#vector-index-transaction-support)), that is they become durable and visible to other queries immediately upon write, unlike other properties. + +###### Important + +The `dimension` must match the dimension of the embeddings in the vertex files. @@ -57 +69 @@ Neptune Analytics, like [Neptune Database](https://docs.aws.amazon.com//neptune/ - * Multi-line string values are not supported. Imports behavior is undefined if the dataset contains multi-line string values. +For more details of loading embeddings, refer to [vector-index](https://docs.aws.amazon.com//neptune-analytics/latest/userguide/vector-index.html). @@ -59 +71 @@ Neptune Analytics, like [Neptune Database](https://docs.aws.amazon.com//neptune/ - * Quoted string values must not have a leading space between the delimiter and quotes. For example, if a line is `abc, “def”` then that is interpreted as a line with two fields, with string values of `abc` and `“def”`. `“def"` is a non-quoted string field and quotes are stored as-is in the value, with a size of 6 characters. If the line is `abc,“def”` then it is interpreted as a line with two fields with string values `abc` and `def`. +### Any type @@ -61 +73 @@ Neptune Analytics, like [Neptune Database](https://docs.aws.amazon.com//neptune/ - * A column type `Any` is supported in the user columns. An `Any` type is a type “syntactic sugar” for all of the other types we support. It is extremely useful if a user column has multiple types in it. The payload of an `Any` type value is a list of json strings as follows: `"{""value"": ""10"", ""type"": ""Int""};{""value"": ""1.0"", ""type"": ""Float""}"` , which has a `value` field and a `type` field in each individual json string. The column header of an `Any` type is `propertyname:Any`. The cardinality value of an `Any` column is `set`, meaning that the column can accept multiple values. +A column type `Any` is supported in the user columns. An `Any` type is a type "syntactic sugar" for all of the other types we support. It is extremely useful if a user column has multiple types in it. The payload of an `Any` type value is a list of json strings as follows: `"{""value"": ""10"", ""type"": ""Int""};{""value"": ""1.0"", ""type"": ""Float""}"` , which has a `value` field and a `type` field in each individual json string. The column header of an `Any` type is `propertyname:Any`. The cardinality value of an `Any` column is `set`, meaning that the column can accept multiple values. @@ -63 +75,3 @@ Neptune Analytics, like [Neptune Database](https://docs.aws.amazon.com//neptune/ - * Neptune Analytics supports the following types in an `Any` type: `Bool` (or `Boolean`), `Byte`, `Short`, `Int`, `Long`, `UnsignedByte`, `UnsignedShort`, `UnsignedInt`, `UnsignedLong`, `Float`, `Double`, `Date`, `dateTime`, and `String`. +Neptune Analytics supports the following types in an `Any` type: `Bool` (or `Boolean`), `Byte`, `Short`, `Int`, `Long`, `UnsignedByte`, `UnsignedShort`, `UnsignedInt`, `UnsignedLong`, `Float`, `Double`, `Date`, `dateTime`, and `String`. + +###### Any type limitations @@ -71,0 +86,17 @@ Neptune Analytics, like [Neptune Database](https://docs.aws.amazon.com//neptune/ +## Limitations and unsupported features + + * Multi-line string values are not supported. Import behavior is undefined if the dataset contains multi-line string values. + + * Quoted string values must not have a leading space between the delimiter and quotes. For example, if a line is `abc, "def"` then that is interpreted as a line with two fields, with string values of `abc` and `"def"`. `"def"` is a non-quoted string field and quotes are stored as-is in the value, with a size of 6 characters. If the line is `abc,"def"` then it is interpreted as a line with two fields with string values `abc` and `def`. + + * `Gzip` files are not supported. + + * Float and double values in scientific notation are currently not supported. However, `Infinity`, `INF`, `-Infinity`, `-INF`, and `NaN` (`Not-a-number`) values are supported. + + * The maximum length of the strings supported is limited to 1,048,062 bytes. The limit is lower for strings with unicode characters since some unicode characters are represented using multiple bytes. + + * The `allowEmptyStrings` parameter is not supported. Empty string values ("") are not treated as null or missing value, and are stored as a property value. + + + +