# Amazon Neptune User Guide > Amazon Neptune is a fast, reliable, fully managed graph database service that makes it easy to build and run applications that work with highly connected datasets. - [What is Neptune?](https://docs.aws.amazon.com/neptune/latest/userguide/intro.md) - [Latest Updates](https://docs.aws.amazon.com/neptune/latest/userguide/doc-history.md) - [Neptune Limits](https://docs.aws.amazon.com/neptune/latest/userguide/limits.md) - [Neptune integrations](https://docs.aws.amazon.com/neptune/latest/userguide/integrations.md) - [Using Neptune APIs](https://docs.aws.amazon.com/neptune/latest/userguide/using-neptune-apis.md) ## [Getting started with Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/graph-get-started.md) - [Quick start using CloudShell](https://docs.aws.amazon.com/neptune/latest/userguide/get-started-quickstart.md): Get started with Amazon Neptune in minutes using AWS CloudShell. - [Using Neptune with graph notebooks](https://docs.aws.amazon.com/neptune/latest/userguide/graph-notebooks.md): This section of the Amazon Neptune User Guide shows you how to use graph notebooks, such as Jupyter Notebooks, to interact with your Amazon Neptune graph database and visualize your data. - [Neptune graph notebooks magics](https://docs.aws.amazon.com/neptune/latest/userguide/notebooks-magics.md): This section of the Amazon Neptune user guide explains how to use "magics" in your Amazon Neptune graph notebooks to simplify the process of querying your Neptune database using SPARQL or Gremlin. - [Graph data visualization](https://docs.aws.amazon.com/neptune/latest/userguide/notebooks-visualization.md): This section of the Amazon Neptune user guide explores how to leverage data visualization capabilities within your Neptune graph notebooks. - [Troubleshooting notebooks](https://docs.aws.amazon.com/neptune/latest/userguide/graph-notebook-troubleshooting.md): Common issues and workarounds for Amazon Neptune notebooks running in JupyterLab. ## [Neptune setup](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-setup.md) - [DB instance types](https://docs.aws.amazon.com/neptune/latest/userguide/instance-types.md): This section of the Amazon Neptune user guide shows you how to choose the right instance types for your Neptune workloads. - [Storage types](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.md): This section of the Amazon Neptune user guide shows you how to choose the appropriate storage types for your Neptune cluster. ### [Create Neptune cluster](https://docs.aws.amazon.com/neptune/latest/userguide/get-started-create-cluster.md) This section of the Amazon Neptune user guide shows you how to create a new Neptune cluster, including configuring the required VPC settings and specifying the cluster parameters. - [Prerequisites](https://docs.aws.amazon.com/neptune/latest/userguide/get-started-prereqs.md): This section of the Amazon Neptune user guide covers the prerequisites for getting started with the service using AWS CloudFormation. - [Create a cluster](https://docs.aws.amazon.com/neptune/latest/userguide/get-started-cfn-create.md): This section of the Amazon Neptune user guide shows you how to use AWS CloudFormation to create a new Neptune cluster. ### [Configure the VPC](https://docs.aws.amazon.com/neptune/latest/userguide/get-started-vpc.md) An Amazon Neptune DB cluster can only be created in an Amazon Virtual Private Cloud (Amazon VPC). - [Dual-stack mode](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dualstack-db-cluster.md): When you create or modify a Neptune DB cluster, you can specify dual-stack mode to allow your resources to communicate with the DB cluster over IPv4, IPv6, or both. ### [Connect to a cluster](https://docs.aws.amazon.com/neptune/latest/userguide/get-started-connecting.md) This section of the Amazon Neptune user guide provides guidance on connecting to your Neptune cluster. - [In the VPC](https://docs.aws.amazon.com/neptune/latest/userguide/get-started-connect-ec2-same-vpc.md): This section of the Amazon Neptune user guide shows you how to connect an Amazon EC2 instance to a Neptune cluster when both are located within the same Virtual Private Cloud (VPC). - [From a different VPC](https://docs.aws.amazon.com/neptune/latest/userguide/get-started-connect-ec2-other-vpc.md): This section of the Amazon Neptune user guide shows you how to connect an Amazon EC2 instance to a Neptune cluster when they are located in different Virtual Private Clouds (VPCs). - [Over a private network](https://docs.aws.amazon.com/neptune/latest/userguide/get-started-connect-private-net.md): This section of the Amazon Neptune user guide provides guidance on connecting to your Neptune cluster over a private network, such as an AWS Direct Connect or VPN connection. - [Public Endpoints](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-public-endpoints.md): Connect to your Neptune database from outside your Amazon VPC using public endpoints. - [Securing access to Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/get-started-security.md): This section of the Amazon Neptune user guide covers the security measures you can implement to protect your Neptune cluster. ### [Accessing graph data](https://docs.aws.amazon.com/neptune/latest/userguide/get-started-access-graph.md) This section of the Amazon Neptune user guide shows you how to access and query the graph data stored in your Neptune cluster. - [Using command-line tools](https://docs.aws.amazon.com/neptune/latest/userguide/get-started-cli-tools.md): How to use the AWS CLI, AWS SDKs, curl, and awscurl to run queries against your Neptune DB cluster. - [Using Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/get-started-graph-gremlin.md): This section of the Amazon Neptune user guide shows you how to use the Gremlin query language to access and traverse the graph data stored in your Neptune cluster. - [Using openCypher](https://docs.aws.amazon.com/neptune/latest/userguide/get-started-graph-opencypher.md): This section of the Amazon Neptune user guide demonstrates how to use the OpenCypher query language to access and interact with the graph data stored in your Neptune cluster. - [Using SPARQL](https://docs.aws.amazon.com/neptune/latest/userguide/get-started-graph-sparql.md): This section of the Amazon Neptune user guide shows you how to use the SPARQL query language to access and interact with the graph data stored in your Neptune cluster. - [Loading data](https://docs.aws.amazon.com/neptune/latest/userguide/get-started-loading.md): This section of the Amazon Neptune user guide covers the process of loading data into your Neptune cluster. - [Monitoring Neptune cluster](https://docs.aws.amazon.com/neptune/latest/userguide/get-started-monitoring.md): This section of the Amazon Neptune user guide shows you how to monitor your Neptune cluster. - [Troubleshooting Neptune cluster](https://docs.aws.amazon.com/neptune/latest/userguide/get-started-troubleshooting.md): This section of the Amazon Neptune user guide provides guidance on troubleshooting issues that may arise with your Neptune cluster. ## [Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless.md) - [Capacity scaling](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-capacity-scaling.md): Setting up a Neptune Serverless DB cluster is similar to setting up a normal provisioned cluster, with additional configuration for minimum and maximum units for scaling, and with the instance type set to db.serverless. - [Additional configuration](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-configuration.md): In addition to setting minimum and maximum capacity for your Neptune Serverless DB cluster, there are a few other configuration choices to consider. - [Using Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.md): You can create a new Neptune DB cluster as a serverless one, or in some cases you can convert an existing DB cluster to use serverless. ## [Neptune global databases](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-global-database.md) - [Setting up a global database](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-gdb-setup.md): This section of the Amazon Neptune user guide provides detailed guidance on setting up a global database for your Neptune cluster. ### [Managing a global database](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-gdb-managing.md) This section of the Amazon Neptune user guide covers the management of a Neptune global database. - [Removing a cluster](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-gdb-detaching.md): There are several reasons you might want to remove a DB cluster from a global database. - [Deleting a global database](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-gdb-deleting.md): You can't delete a global database and its associated clusters in a single step. - [Modifying a global database](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-gdb-modifying.md): The DB cluster parameter groups can be configured independently for each Neptune DB cluster in a global database, but it's best to keep settings consistent across the clusters to avoid unexpected behavior changes if a secondary cluster has to be promoted to primary. - [Disaster recovery in Neptune database](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-gdb-disaster-recovery.md): This section of the Amazon Neptune user guide shows you how to perform disaster recovery, including how to back up and restore your data, set up replication, and recover your database in the event of a disaster. - [Monitoring Neptune deployments](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-gdb-monitoring.md): This section of the Amazon Neptune user guide shows you how to monitor your Neptune deployment, including how to use Amazon CloudWatch to view metrics, set alarms, and analyze logs. ## [Neptune overview](https://docs.aws.amazon.com/neptune/latest/userguide/feature-overview.md) ### [Standards Compliance](https://docs.aws.amazon.com/neptune/latest/userguide/feature-overview-standards-compliance.md) Amazon Neptune complies with applicable standards in implementing the Gremlin and SPARQL graph query languages in most cases. - [Gremlin standards compliance](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-differences.md): Overview of differences between the Neptune and TinkerPop implementations of Gremlin. - [SPARQL standards compliance](https://docs.aws.amazon.com/neptune/latest/userguide/feature-sparql-compliance.md): Overview of Neptune compliance with SPARQL graph query language standards. - [openCypher specification compliance](https://docs.aws.amazon.com/neptune/latest/userguide/feature-opencypher-compliance.md): Overview of Neptune compliance with openCypher graph query language specification. ### [Graph Data Model](https://docs.aws.amazon.com/neptune/latest/userguide/feature-overview-data-model.md) Learn about the four positions of a Neptune quad element. - [The dictionary](https://docs.aws.amazon.com/neptune/latest/userguide/feature-overview-storage-dictionary.md): Neptune does not store most user-facing values directly in the various indexes it maintains. - [Indexing Strategy](https://docs.aws.amazon.com/neptune/latest/userguide/feature-overview-storage-indexing.md): How Neptune uses indexing. ### [Graph schema and metadata](https://docs.aws.amazon.com/neptune/latest/userguide/graph-schema-metadata.md) Discover and inspect the structure of your Neptune graph data using graph summary, property graph schema, and DFE statistics. - [Graph summary API](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-graph-summary.md): The Neptune graph summary API retrieves the following information about your graph: - [Property graph schema](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-pg-schema.md): Use the neptune.graph.pg_schema() procedure to retrieve the complete schema of your property graph, including node labels, edge labels, properties, data types, and label triples. - [DFE statistics](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.md) ### [Lookup cache](https://docs.aws.amazon.com/neptune/latest/userguide/feature-overview-lookup-cache.md) Amazon Neptune implements a lookup cache that uses the R5d instance's NVMe-based SSD to improve read performance for queries with frequent, repetitive lookups of property values or RDF literals. - [Use cases for the lookup cache](https://docs.aws.amazon.com/neptune/latest/userguide/feature-overview-lookup-cache-when-to-use.md): The lookup cache only helps when your read queries are returning the properties of a very large number of vertices and edges, or of RDF triples. - [Using the cache](https://docs.aws.amazon.com/neptune/latest/userguide/feature-overview-lookup-cache-using.md): The lookup cache is only available on an R5d instance type, where it is automatically enabled by default. ### [Transaction Semantics](https://docs.aws.amazon.com/neptune/latest/userguide/transactions.md) How Neptune handles transactions and isolation levels. - [Isolation Levels](https://docs.aws.amazon.com/neptune/latest/userguide/transactions-isolation-levels.md): Describes isolation levels as defined in the SQL:92 standard. - [Neptune Isolation Levels](https://docs.aws.amazon.com/neptune/latest/userguide/transactions-neptune.md): Neptune implements different transaction isolation levels for read-only and mutation queries. - [Transaction examples](https://docs.aws.amazon.com/neptune/latest/userguide/transactions-examples.md): Examples of transaction isolation levels in Neptune. - [Clusters and Instances](https://docs.aws.amazon.com/neptune/latest/userguide/feature-overview-db-clusters.md): Learn about DB clusters and Instances on Neptune. - [Storage, reliability and availability](https://docs.aws.amazon.com/neptune/latest/userguide/feature-overview-storage.md): Amazon Neptune uses a distributed and shared storage architecture that scales automatically as your database storage needs grow. ### [Endpoint Connections](https://docs.aws.amazon.com/neptune/latest/userguide/feature-overview-endpoints.md) Amazon Neptune uses a cluster of DB instances rather than a single instance. - [Working with custom endpoints](https://docs.aws.amazon.com/neptune/latest/userguide/feature-custom-endpoint-membership.md): When you add a DB instance to a custom endpoint or remove it from a custom endpoint, any existing connections to that DB instance remain active. - [Lab Mode](https://docs.aws.amazon.com/neptune/latest/userguide/features-lab-mode.md): Use Neptune lab mode to enable new features that are present in the current release. ### [Neptune DFE engine](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-engine.md) Amazon Neptune has a fast and efficient new engine. - [Controlling DFE use](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-enabling-disabling.md): By default, the instance parameter of an instance is set to viaQueryHint, which causes the DFE engine to be used only for openCypher queries and for Gremlin and SPARQL queries that explicitly include the useDFE query hint set to true. - [Queries executed by the DFE](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-suppoorts-subset.md): Currently, the Neptune DFE supports a subset of SPARQL and Gremlin query constructs. ### [JDBC connectivity](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-jdbc.md) Amazon Neptune has released an open-source JDBC driver that supports openCypher, Gremlin, SQL-Gremlin, and SPARQL queries. - [Getting started](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-jdbc-getting-started.md): To use the Neptune JDBC driver to connect to a Neptune instance, either the JDBC driver must be deployed on an Amazon EC2 instance in the same VPC as your Neptune DB cluster, or the instance must be available through an SSH tunnel or load balancer. - [Using Tableau](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-jdbc-tableau.md): To use Tableau with the Neptune JDBC driver, start by downloading and installing the most recent version of Tableau Desktop. - [Troubleshooting](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-jdbc-troubleshooting.md): If the driver fails to connect to the server, use the isValid function of the JDBC Connection object to check whether the connection is valid. - [Neptune engine updates](https://docs.aws.amazon.com/neptune/latest/userguide/features-engine-updates.md): Updating the Neptune engine. - [Exceptions and Retries](https://docs.aws.amazon.com/neptune/latest/userguide/transactions-exceptions.md): Learn how to implement effective retry strategies for Neptune applications to handle transient errors and improve reliability. ## [Security](https://docs.aws.amazon.com/neptune/latest/userguide/security.md) - [Amazon Neptune operating system upgrades](https://docs.aws.amazon.com/neptune/latest/userguide/security-os-upgrades.md): Amazon Neptune ensures continuous improvements in database performance, security, and stability through regular OS upgrades. ### [Protecting data in Neptune databases](https://docs.aws.amazon.com/neptune/latest/userguide/data-protection.md) This section of the Amazon Neptune user guide describes the data protection features available for your Neptune database, including backup, restore, and encryption options to help safeguard your data. - [Securing Neptune databases with Amazon VPC](https://docs.aws.amazon.com/neptune/latest/userguide/security-vpc.md): This section of the Amazon Neptune user guide explains how to use Amazon Virtual Private Cloud (Amazon VPC) to secure your Neptune database, including how to control network access and isolate your database within a private network. - [Encrypting connects to Neptune databases](https://docs.aws.amazon.com/neptune/latest/userguide/security-ssl.md): This section of the Amazon Neptune user guide describes how to encrypt connections to your Neptune database using Secure Sockets Layer (SSL) or Transport Layer Security (TLS) protocols, providing secure data transmission between your application and the database. - [Encrypting data at Rest](https://docs.aws.amazon.com/neptune/latest/userguide/encrypt.md): This section of the Amazon Neptune user guide explains how to encrypt data at rest in your Neptune database using AWS Key Management Service (AWS KMS) to protect sensitive information stored in your database. - [Authenticating with IAM](https://docs.aws.amazon.com/neptune/latest/userguide/iam-auth.md): This section of the Amazon Neptune user guide describes how to use AWS Identity and Access Management (IAM) to authenticate users and applications that connect to your Neptune database, providing a secure way to control access to your data. - [Enabling IAM](https://docs.aws.amazon.com/neptune/latest/userguide/iam-auth-enable.md): This section of the Amazon Neptune user guide explains how to enable IAM database authentication for your Neptune database, allowing you to use IAM credentials to authenticate and manage access to your database resources. ### [Connecting with IAM authentication](https://docs.aws.amazon.com/neptune/latest/userguide/iam-auth-connecting.md) This section of the Amazon Neptune user guide provides guidance on how to connect to your Neptune database using IAM authentication, including the necessary steps and sample code for various programming languages and tools. - [Prerequisites](https://docs.aws.amazon.com/neptune/latest/userguide/iam-auth-connect-prerq.md): This section of the Amazon Neptune user guide outlines the prerequisites for connecting to your Neptune database using IAM authentication, including setting up the necessary AWS resources and configuring your application to support IAM-based authentication. - [Connecting from the command line](https://docs.aws.amazon.com/neptune/latest/userguide/iam-auth-connect-command-line.md): This section of the Amazon Neptune user guide provides instructions on how to connect to your Neptune database using IAM authentication from the command line, including examples for various tools and programming languages. - [Connecting from Gremlin Console](https://docs.aws.amazon.com/neptune/latest/userguide/iam-auth-connecting-gremlin-console.md): This section of the Amazon Neptune user guide explains how to connect to your Neptune database using IAM authentication with the Gremlin Console with Signature Version 4 Signing. - [Connecting using Gremlin Java](https://docs.aws.amazon.com/neptune/latest/userguide/iam-auth-connecting-gremlin-java.md): This section of the Amazon Neptune user guide provides instructions on how to connect to your Neptune database using IAM authentication with the Gremlin Java API with Signature Version 4 authentication. - [Connecting with SPARQL Java](https://docs.aws.amazon.com/neptune/latest/userguide/iam-auth-connecting-sparql-java.md): This section of the Amazon Neptune user guide explains how to connect to your Neptune database using IAM authentication with the SPARQL Java API (RDF4J or Apache Jena) with Signature Version 4 authentication. - [Conncting with SPARQL and Node.js](https://docs.aws.amazon.com/neptune/latest/userguide/iam-auth-connecting-sparql-node.md): This section of the Amazon Neptune user guide provides instructions on how to connect to your Neptune database using IAM authentication with the SPARQL Node.js API with Signature Version 4 authentication. - [Connecting with Python](https://docs.aws.amazon.com/neptune/latest/userguide/iam-auth-connecting-python.md): Connect to an IAM-enabled Neptune database using Python. - [Gremlin Python](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-python-iam-auth.md) - [Gremlin Javascript](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-javascript-iam-auth.md) - [Gremlin Go](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-go-iam-auth.md) - [Gremlin .NET](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-dotnet-iam-auth.md) ### [Using IAM policies](https://docs.aws.amazon.com/neptune/latest/userguide/security-iam-access-manage.md) This section of the Amazon Neptune user guide describes how to use AWS Identity and Access Management policies to manage and control access to your Neptune database, ensuring only authorized users and applications can interact with your graph data. ### [Using managed policies](https://docs.aws.amazon.com/neptune/latest/userguide/security-iam-access-managed-policies.md) This section of the Amazon Neptune user guide explains how to use AWS-managed IAM policies to grant access to your Neptune database, providing a convenient way to set up permissions without having to create custom policies. - [Granting read-only access](https://docs.aws.amazon.com/neptune/latest/userguide/read-only-access-iam-managed-policy.md): This section of the Amazon Neptune user guide describes how to grant read-only access to your Neptune graph using an AWS-managed IAM policy, allowing users to view but not modify your graph data. - [Granting Full Access](https://docs.aws.amazon.com/neptune/latest/userguide/full-access-iam-managed-policy.md): This section of the Amazon Neptune user guide explains how to grant full access to your Neptune database using an AWS-managed IAM policy, allowing users to perform all operations on your graph data. - [Granting full access to Neptune console](https://docs.aws.amazon.com/neptune/latest/userguide/console-full-access-iam-managed-policy.md): This section of the Amazon Neptune user guide describes how to grant full access to the Neptune console using an AWS-managed IAM policy, allowing users to perform all administrative tasks and access all features of the Neptune management console. - [Using condition Keys](https://docs.aws.amazon.com/neptune/latest/userguide/iam-condition-keys.md): This section of the Amazon Neptune user guide explains how to use IAM condition keys to customize and fine-tune access to your Neptune database, allowing you to create more granular and specific IAM policies. ### [IAM administrative policy statements](https://docs.aws.amazon.com/neptune/latest/userguide/iam-admin-policies.md) This section of the Amazon Neptune user guide provides guidance on how to create custom IAM policies to manage and administer your Neptune graph, including examples of policies for common administrative tasks. - [Administrative actions](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-iam-admin-actions.md): This section of the Amazon Neptune user guide provides a reference of the IAM actions that can be used to grant permissions for administering your Neptune database, including actions for managing instances, clusters, and other resources. - [Resources types](https://docs.aws.amazon.com/neptune/latest/userguide/iam-admin-resources.md): This section of the Amazon Neptune user guide lists the IAM resource types that can be used to grant permissions for administering your Neptune database, including Neptune-specific resources and general AWS resources. - [Condition Keys](https://docs.aws.amazon.com/neptune/latest/userguide/iam-admin-condition-keys.md): This section of the Amazon Neptune user guide describes the IAM condition keys that can be used to create more granular and specific policies for administering your Neptune database, allowing you to control access based on various conditions and context. - [Administrative policy examples](https://docs.aws.amazon.com/neptune/latest/userguide/iam-admin-policy-examples.md): This section of the Amazon Neptune user guide provides example IAM adminstrative policies that you can use as a starting point for administering your Neptune database, including policies for common administrative tasks such as managing instances, clusters, and backups. ### [Custom data-access policy statements](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-access-policies.md) This section of the Amazon Neptune user guide explains how to create custom IAM policies to control access to the data stored in your Neptune database, allowing you to grant fine-grained permissions for different users and applications. - [Data access actions](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.md): This section of the Amazon Neptune user guide provides a reference of the IAM actions that can be used to grant permissions for data in your Neptune database, including actions for managing backups, restores, and other data protection features. - [Data acccess resources](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-resources.md): This section of the Amazon Neptune user guide lists the IAM resource types that can be used to grant permissions for accessing the data stored in your Neptune database, including Neptune-specific resources and general AWS resources. - [Condition Keys](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.md): This section of the Amazon Neptune user guide describes the IAM condition keys that can be used to create more granular and specific policies for controlling access to the data in your Neptune database, allowing you to enforce additional constraints and conditions. - [Data-access policy examples](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-access-examples.md): This section of the Amazon Amazon Neptune user guide provides example IAM data-access policies that you can use as a starting point for controlling access to the data stored in your Neptune database, including policies for common data access scenarios. - [Tag-based access control (TBAC)](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-tbac.md): Learn how to use tag-based access control (TBAC) to restrict access to Neptune data-plane operations based on tag alignment between IAM principals and Neptune DB cluster resources. - [Service-Linked Roles](https://docs.aws.amazon.com/neptune/latest/userguide/security-iam-service-linked-roles.md): This section of the Amazon Neptune user guide explains how to use service-linked roles for Neptune to manage permissions and access to your database, allowing other AWS services to interact with Neptune resources. - [Temporary credentials](https://docs.aws.amazon.com/neptune/latest/userguide/iam-auth-temporary-credentials.md): This section of the Amazon Neptune user guide explains how to use temporary credentials, such as those provided by AWS Security Token Service, to connect to your Neptune database, allowing you to grant limited-time access to users or applications. - [Logging and Monitoring](https://docs.aws.amazon.com/neptune/latest/userguide/security-monitoring.md): This section of the Amazon Amazon Neptune user provides resources that monitor the usage and performance of Neptune clusters and log the data. - [Interface VPC endpoints (AWS PrivateLink)](https://docs.aws.amazon.com/neptune/latest/userguide/vpc-interface-endpoints.md): Use AWS PrivateLink to privately access Amazon Neptune API endpoints from your VPC. - [Compliance considerations](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-compliance.md): This section of the Amazon Neptune user guide discusses compliance considerations for your Neptune database, including information about security and compliance regulations, auditing, and other factors to keep in mind when using Neptune in regulated environments. - [Building resilient deployments](https://docs.aws.amazon.com/neptune/latest/userguide/disaster-recovery-resiliency.md): This section of the Amazon Neptune user guide provides guidance on how to build resilient and disaster-tolerant Neptune deployments, including strategies for ensuring high availability, data durability, and business continuity in the face of failures or disruptions. ## [Migrating to Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/migrating.md) ### [Migrating from Neo4j](https://docs.aws.amazon.com/neptune/latest/userguide/migrating-from-neo4j.md) Overview of how to migrate an existing graph from Neo4j into Neptune. - [General information](https://docs.aws.amazon.com/neptune/latest/userguide/migrating-from-neo4j-general.md): With Neptune support for the openCypher query language, you can move most Neo4j workloads that use the Bolt protocol or HTTPS to Neptune. ### [Preparing for migration](https://docs.aws.amazon.com/neptune/latest/userguide/preparing-to-migrate-from-neo4j.md) Migrating from the Neo4j graph database to the Neptune graph database service can be approached in one of two main ways: re-platforming or refactoring/re-architecting. - [Architectural differences](https://docs.aws.amazon.com/neptune/latest/userguide/migration-architectural-differences.md): When customers first consider migrating an application from Neo4j to Neptune, it is often tempting to perform a like-to-like comparison based on instance size. - [Data storage differences](https://docs.aws.amazon.com/neptune/latest/userguide/migration-storage-differences.md): Neptune uses a graph data model based on a native quad model. - [Operational differences](https://docs.aws.amazon.com/neptune/latest/userguide/migration-operational-differences.md): Neptune is a fully managed service that automates many of the normal operational tasks you would have to do when using on-premise or self-managed databases such as Neo4j Enterprise or Community Edition: - [Provisioning infrastructure](https://docs.aws.amazon.com/neptune/latest/userguide/migration-provisioning-infrastructure.md): Amazon Neptune clusters are built to scale in three dimensions: storage, write capacity, and read capacity. - [Data migration](https://docs.aws.amazon.com/neptune/latest/userguide/migration-data-migration.md): When performing a migration from Neo4j to Amazon Neptune, migrating the data is a major step in the process. - [Application migration](https://docs.aws.amazon.com/neptune/latest/userguide/migration-app-migration.md): After you have migrated your data from Neo4j to Neptune, the next step is to migrate the application itself. - [Neptune compatibility](https://docs.aws.amazon.com/neptune/latest/userguide/migration-compatibility.md): Neo4j's has an all-in-one architectural approach, where data loading, data ETL, application queries, data storage, and management operations all occur in the same set of compute resources, such as EC2 instances. - [Cypher rewrites](https://docs.aws.amazon.com/neptune/latest/userguide/migration-opencypher-rewrites.md): The openCypher language is a declarative query language for property graphs that was originally developed by Neo4j, then open-sourced in 2015, and contributed to the openCypher project under an Apache 2 open-source license. - [Migration resources](https://docs.aws.amazon.com/neptune/latest/userguide/migration-resources.md): Neptune provides several tools and resources that can assist in the migration process. - [Migrating from TinkerPop](https://docs.aws.amazon.com/neptune/latest/userguide/migrating-from-tinkerpop.md): Overview of how to migrate from an Apache TinkerPop Gremlin server to Neptune. - [Migrating from RDF](https://docs.aws.amazon.com/neptune/latest/userguide/migrating-from-rdf.md): Overview of how to migrate from an RDF triple store to Neptune. - [Using AWS DMS to migrate](https://docs.aws.amazon.com/neptune/latest/userguide/migrating-using-dms.md): Overview of using AWS DMS to migrate existing graph data into Neptune. - [Migrating from Blazegraph](https://docs.aws.amazon.com/neptune/latest/userguide/migrating-from-blazegraph.md): Overview of how to migrate from Blazegraph to Neptune. ## [Loading data](https://docs.aws.amazon.com/neptune/latest/userguide/load-data.md) ### [Neptune Bulk Loader](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load.md) Overview of how to load data from external files into a Neptune DB instance using the Neptune bulk loader. ### [IAM Role and Amazon S3 Access](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-IAM.md) Prerequisites for loading data from an S3 bucket into Neptune. - [Creating an IAM role to access Amazon S3](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-IAM-CreateRole.md): Use the AmazonS3ReadOnlyAccess managed IAM policy to create a new IAM role that will allow Amazon Neptune access to Amazon S3 resources. - [Adding the IAM Role to a Cluster](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-IAM-add-role-cluster.md): Use the console to add the IAM role to an Amazon Neptune cluster. - [Creating the VPC Endpoint](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-vpc.md): The Neptune loader requires a VPC endpoint of type Gateway for Amazon S3. - [Chaining IAM roles](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-chain-roles.md) ### [Data Formats](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format.md) List of data formats that are available for the Neptune Load API. - [Gremlin data format](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.md): Requirements for loading Gremlin data into Neptune. - [openCypher data format](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.md): Requirements for loading RDF data into Neptune. - [RDF data formats](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-rdf.md): Requirements for loading RDF data into Neptune. - [Loading Example](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-data.md): Example of loading data into Amazon Neptune. - [Optimizing a bulk load](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-optimize.md): Use the following strategies to keep the load time to a minimum for a Neptune bulk load: ### [Loader Reference](https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference.md) Loader APIs for Amazon Neptune that are available from the HTTP endpoint of a Neptune DB instance. ### [Loader Command](https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-load.md) Loads data from an Amazon S3 bucket into a Neptune DB instance. - [Errors](https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-load-errors.md): When an error occurs, a JSON object is returned in the BODY of the response. - [Examples](https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-load-examples.md): This example demonstrates how to use the Neptune loader to load data into a Neptune graph database using the Gremlin CSV format. ### [Get-Status API](https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.md) Gets the status of a loader job. - [Requests](https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status-requests.md) - [Responses](https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status-response.md): The following example response from the Neptune Get-Status API describes the overall structure of the response, explains the various fields and their data types, as well as the error handling and error log details. - [Examples](https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status-examples.md): The following examples showcase the usage of the Neptune loader's GET-Status API, which allows you to retrieve information about the status of your data loads into the Amazon Neptune graph database. - [errorLogs examples](https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-error-logs-examples.md): The following examples showcase the detailed status response from the Neptune loader when errors have occurred during the data loading process. - [Cancel Job](https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-cancel.md): Cancels a load job. ### [Load data using DMS](https://docs.aws.amazon.com/neptune/latest/userguide/dms-neptune.md) Overview of how to use AWS Database Migration Service (AWS DMS) to load data into Neptune. - [GraphMappingConfig](https://docs.aws.amazon.com/neptune/latest/userguide/dms-neptune-graph-mapping.md): The GraphMappingConfig that you create specifies how data extracted from a source data store should be loaded into a Neptune DB cluster. - [Replicating to Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/dms-neptune-replication.md): Once you have created your table mapping and graph mapping configurations, use the following process to load data from the source store into Neptune. - [Load data using queries](https://docs.aws.amazon.com/neptune/latest/userguide/load-data-via-query.md): Overview of how to load data from external files into a Neptune DB instance using Neptune's supported query languages. ## [Storage](https://docs.aws.amazon.com/neptune/latest/userguide/storage.md) - [Dictionary garbage collection](https://docs.aws.amazon.com/neptune/latest/userguide/storage-gc.md): Neptune supports dictionary garbage collection (GC) which can be enabled via the neptune_lab_mode parameter for property graph data. - [Inlined server-generated edge ID](https://docs.aws.amazon.com/neptune/latest/userguide/storage-edge-id.md): Neptune supports inline Server-Generated Edge IDs. ## [Querying](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-queries.md) - [Query queuing](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-queuing.md): How queries are queued in Neptune and how queuing can affect performance. - [Query plan cache](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-qpc.md): How Amazon Neptune utilizes the query plan cache to reduce the overall latency and avoid parsing and optimization for repeated patterns. - [Custom queryId](https://docs.aws.amazon.com/neptune/latest/userguide/features-query-id.md): You can inject your own custom queryId into a Gremlin or SPARQL query. ### [Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin.md) Set up your environment to use Gremlin to access a Neptune graph. ### [Installing the Gremlin console](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-console.md) Steps for connecting to Neptune using the Gremlin Console. - [Another way to connect](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-console-connect.md): Drawbacks of the normal connection approach ### [HTTPS REST](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-rest.md) Steps for connecting to Neptune using the HTTPS REST Endpoint. - [Enable multi-part responses](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-rest-trailing-headers.md): By default, the HTTP response to Gremlin queries is returned in a single JSON result set. ### [Java](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-client.md) You can use either of two open-source Java-based Gremlin clients with Amazon Neptune: the Apache TinkerPop Java Gremlin client, or the Gremlin client for Amazon Neptune. - [Using a Java client](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-java.md): Steps for connecting to Neptune using Java - [Java reconnect sample](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-java-reconnect-example.md): Steps for connecting to Neptune using Java with reconnect logic - [Python](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-python.md): Steps for connecting to Neptune using Python. - [.NET](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-dotnet.md): Steps for connecting to Neptune using .NET. - [Node.js](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-node-js.md): Steps for connecting to Neptune using Node.js. - [Go](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-go.md): Steps for connecting to Neptune using the Go language. - [AWS SDK](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-sdk.md): Run Gremlin queries against a Neptune graph using the AWS SDK. ### [Query hints](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-query-hints.md) You can use query hints to specify optimization and evaluation strategies for a particular Gremlin query in Amazon Neptune. - [repeatMode](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-query-hints-repeatMode.md): The Neptune repeatMode query hint specifies how the Neptune engine evaluates the repeat() step in a Gremlin traversal: breadth first, depth first, or chunked depth first. - [noReordering](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-query-hints-noReordering.md): When you submit a Gremlin traversal, the Neptune query engine investigates the structure of the traversal and reorders parts of the query, trying to minimize the amount of work required for evaluation and query response time. - [typePromotion](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-query-hints-typePromotion.md): When you submit a Gremlin traversal that filters on a numerical value or range, the Neptune query engine must normally use type promotion when it executes the query. - [useDFE](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-query-hints-useDFE.md): Use this query hint to enable use of the DFE for executing the query. - [evaluationTimeoutBehavior](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-query-hints-evaluationTimeoutBehavior.md): Use the evaluationTimeoutBehavior query hint to return partial results when a Gremlin query exceeds the timeout. - [Results cache query hints](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-query-hints-results-cache.md): The following query hints can be used when the query results cache is enabled. - [Query status](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status.md): Information about using the Gremlin query status HTTP API in Neptune. - [Query cancellation](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status-cancel.md): Information about using the Gremlin query cancellation HTTP API in Neptune. - [Gremlin script-based sessions](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-sessions.md): How to use Gremlin script-based sessions with implicit transactions in Neptune. - [Gremlin transactions](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-transactions.md): How to use Gremlin transactions in Neptune. - [Streaming results](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-streaming.md): When you run a Gremlin traversal that returns a large number of results, Neptune streams them back to the client in batches over the WebSocket connection. - [Using the Gremlin API](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-reference.md): Overview of using Gremlin HTTP(S) API with Neptune. - [Caching query results](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-results-cache.md): Overview of using the query results cache with Gremlin. - [Efficient upserts from 3.6.x forward](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-efficient-upserts.md): How to optimize upserts in Gremlin using mergeV() and mergeE(). - [Efficient upserts before 3.6.x](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-efficient-upserts-pre-3.6.md): How to optimize upserts in Gremlin. ### [Gremlin explain](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-explain.md) Use the Gremlin explain feature in Neptune to understand and improve your query execution. ### [Background information](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-explain-background.md) Understand how to use the Neptune Gremlin explain/profile feature. - [Statements](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-explain-background-statements.md): Gremlin uses statements to represent data in Neptune. - [Statement Indexes](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-explain-background-indexing-examples.md): Gremlin uses statement indexes to process queries in Neptune. - [Query processing](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-explain-background-querying.md): How Gremlin processes queries in Neptune. - [Gremlin explain API](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-explain-api.md): How to use the Gremlin explain API in Neptune. - [Gremlin profile API](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.md): The Gremlin profile feature in Neptune runs a specified traversal, collects metrics about the run, and produces a profile report. - [Tuning Gremlin queries](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.md): Learn how to tune Gremlin queries in Neptune. - [Gremlin step support](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-step-support.md): The Amazon Neptune engine does not currently have full native support for all Gremlin steps, as explained in . ### [Gremlin and DFE](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-with-dfe.md) You can enable Neptune's alternative query engine, known as the DFE, in two ways: - [Gremlin step coverage in DFE](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-step-coverage-in-DFE.md): Gremlin DFE is an experimental feature and can be used by either enabling the instance parameter or using the Neptune#useDFE query hint. ### [openCypher](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher.md) Set up your environment to use the openCypher query language to access a Neptune graph. - [Using openCypher](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-overview-getting-started.md): You can query property-graph data in Neptune using openCypher regardless of how it was loaded, but you can't use openCypher to query data loaded as RDF. - [Status endpoint](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-status.md): The openCypher status endpoint provides access to information about queries that are currently running on the server or waiting to run. - [HTTPS endpoint](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-queries.md) - [AWS SDK](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-sdk.md): Run openCypher queries against a Neptune graph using the AWS SDK. - [Using the Bolt protocol](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-bolt.md): Bolt is a statement-oriented client/server protocol initially developed by Neo4j and licensed under the Creative Commons 3.0 Attribution-ShareAlike license. - [Parameterized examples](https://docs.aws.amazon.com/neptune/latest/userguide/opencypher-parameterized-queries.md): Neptune supports parameterized openCypher queries. - [Data model](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-data-model.md): The Neptune openCypher engine builds on the same property-graph model as Gremlin. ### [openCypher explain](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-explain.md) The openCypher explain feature is a self-service tool in Amazon Neptune that helps you understand the execution approach taken by the Neptune engine. - [Example: relationship lookup](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-explain-example-2.md): This query looks for relationships between two anonymous nodes with type route, and returns at most 10. - [Example: value function](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-explain-example-3.md): The function is: - [Example: mathematical expression](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-explain-example-4.md): In this example, RETURN abs(-10) performs a simple evaluation, taking the absolute value of a constant, -10. - [Example: variable-length path](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-explain-example-5.md): This is an example of a more complex query plan for handling a variable-length path query. - [Transactions](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-transactions.md): The openCypher implementation in Amazon Neptune uses the transaction semantics defined by Neptune However, isolation levels provided by the Bolt driver have some specific implications for Bolt transaction semantics, as described in the sections below. - [Streaming results](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-streaming.md): When you run an openCypher query that returns a large number of records, you don't have to load the entire result set into client memory at once. ### [Query hints](https://docs.aws.amazon.com/neptune/latest/userguide/opencypher-query-hints.md) - [Query plan cache](https://docs.aws.amazon.com/neptune/latest/userguide/opencypher-query-hints-qpc-hint.md): Query plan cache behavior can be overridden on a per-query (parameterized or not) basis by query-level query hint QUERY:PLANCACHE. - [AssumeConsistentDataTypes hint](https://docs.aws.amazon.com/neptune/latest/userguide/opencypher-query-hints-AssumeConsistentDataTypes.md): openCypher follows a paradigm where matches of numerical datatypes (e.g., int, byte, short, long, etc.) are carried out under type promotion semantics. - [Query timeout](https://docs.aws.amazon.com/neptune/latest/userguide/opencypher-query-hints-timeout-hint.md): Query timeout behavior can be configured on a per-query basis by query-level query hint QUERY:TIMEOUTMILLISECONDS. - [Restrictions](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-limitations.md): The Amazon Neptune release of openCypher still does not support everything that is specified in the Cypher Query Language Reference, Version 9, as is detailed in . - [Exceptions](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-exceptions.md): When working with openCypher on Amazon Neptune, a variety of exceptions may occur. ### [Extensions](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-extensions.md) Amazon Neptune supports the openCypher specification reference version 9. ### [neptune.read()](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-21-extensions-s3-read.md) Neptune supports a CALL procedure neptune.read to read data from Amazon S3 and then run an openCypher query (read, insert, update) using the data. - [Query examples using parquet](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-21-extensions-s3-read-parquet.md): The following example query returns the number of rows in a given Parquet file: - [Query examples using CSV](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-21-extensions-s3-read-csv.md): In this example, the query returns the number of rows in a given CSV file: - [neptune.read() permissions](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-21-extensions-s3-read-permissions.md): Required IAM policies and permissions for using neptune.read() with openCypher queries. ### [Spatial Data](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-22-spatial-data.md) Learn how to query spatial data in Neptune using spatial types and functions. ### [Spatial Functions](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-22-spatial-functions.md) Reference for spatial functions available in Neptune openCypher. - [ST_Point](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-22-spatial-functions-st-point.md): ST_Point returns a point from the input coordinate values. - [ST_GeomFromText](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-22-spatial-functions-st-geomfromtext.md): ST_GeomFromText constructs a geometry object from a well-known text (WKT) representation of an input geometry. - [ST_AsText](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-22-spatial-functions-st-astext.md): ST_AsText returns the well-known text (WKT) representation of an input geometry. - [ST_GeometryType](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-22-spatial-functions-st-geometrytype.md): ST_GeometryType returns the type of the geometry as a string. - [ST_Equals](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-22-spatial-functions-st-equals.md): ST_Equals returns true if the 2D projections of the input geometries are topologically equal. - [ST_Contains](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-22-spatial-functions-st-contains.md): ST_Contains returns true if the 2D projection of the first input geometry contains the 2D projection of the second input geometry. - [ST_Intersects](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-22-spatial-functions-st-intersect.md): ST_Intersects returns true if the 2D projections of the two input geometries have at least one point in common. - [ST_Distance](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-22-spatial-functions-st-distance.md): For input geometries, ST_Distance returns the minimum Euclidean distance between the 2D projections of the two input geometry values. - [ST_DistanceSpheroid](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-22-spatial-functions-st-distancespheroid.md): Returns the minimum distance in meters between two lon/lat geometries. - [ST_Envelope](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-22-spatial-functions-st-envelope.md): ST_Envelope returns the minimum bounding box of the input geometry, as follows: - [ST_Buffer](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-22-spatial-functions-st-buffer.md): ST_Buffer returns 2D geometry that represents all points whose distance from the input geometry projected on the xy-Cartesian plane is less than or equal to the input distance. ### [SPARQL](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-sparql.md) Set up your environment to use SPARQL to access Neptune. - [RDF4J Console](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-sparql-rdf4j-console.md): Steps for connecting to Neptune using the RDF4J console. - [RDF4J Workbench](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-sparql-rdf4j-workbench.md): Steps for connecting to Neptune using RDF4J Workbench. - [Java](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-sparql-java.md): Steps for connecting to Neptune using Java and performing a SPARQL query. ### [HTTP API](https://docs.aws.amazon.com/neptune/latest/userguide/sparql-api-reference.md) Information about using the SPARQL HTTP API in Neptune. - [HTTP REST](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-sparql-http-rest.md): Steps for connecting to Neptune using the HTTP REST endpoint and performing a SPARQL query. - [Optional HTTP trailing headers](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-sparql-http-trailing-headers.md): The HTTP response to SPARQL queries and updates is often returned in more than one part or chunk. - [RDF media-type support](https://docs.aws.amazon.com/neptune/latest/userguide/sparql-media-type-support.md): Resource Description Framework (RDF) data can be serialized in many different ways, most of which SPARQL can consume or output: - [SPARQL UPDATE LOAD](https://docs.aws.amazon.com/neptune/latest/userguide/sparql-api-reference-update-load.md): The syntax of the SPARQL UPDATE LOAD command is specified in the SPARQL 1.1 Update recommendation: - [SPARQL UPDATE UNLOAD](https://docs.aws.amazon.com/neptune/latest/userguide/sparql-api-reference-unload.md): Neptune also provides a custom SPARQL operation, UNLOAD, for removing data that is specified in a remote source. ### [Query hints](https://docs.aws.amazon.com/neptune/latest/userguide/sparql-query-hints.md) Use query hints to specify optimization and evaluation strategies for a particular SPARQL query in Neptune. - [joinOrder](https://docs.aws.amazon.com/neptune/latest/userguide/sparql-query-hints-joinOrder.md): Use the Neptune joinOrder query hint to specify that the query should be evaluated in a given order. - [evaluationStrategy](https://docs.aws.amazon.com/neptune/latest/userguide/sparql-query-hints-evaluationStrategy.md): Use the evaluationStrategy query hint to tell Amazon Neptune that a query fragment should be evaluated from the bottom up as an independent unit. - [queryTimeout](https://docs.aws.amazon.com/neptune/latest/userguide/sparql-query-hints-queryTimeout.md): Use the queryTimeout query hint to reduce the time it takes for a query to time out. - [rangeSafe](https://docs.aws.amazon.com/neptune/latest/userguide/sparql-query-hints-rangeSafe.md): Use the rangeSafe query hint to turn off type promotion. - [queryId](https://docs.aws.amazon.com/neptune/latest/userguide/sparql-query-hints-queryId.md): Use the queryId query hint to assign your own ID value to a SPARQL query. - [useDFE](https://docs.aws.amazon.com/neptune/latest/userguide/sparql-query-hints-useDFE.md): Use the useDFE query hint to turn use of the DFE alternative query engine on or off. - [DESCRIBE query hints](https://docs.aws.amazon.com/neptune/latest/userguide/sparql-query-hints-for-describe.md): A SPARQL DESCRIBE query provides a flexible mechanism for requesting resource descriptions. - [DESCRIBE and the default graph](https://docs.aws.amazon.com/neptune/latest/userguide/sparql-default-describe.md): Neptune implements SPARQL DESCRIBE using the default graph. - [Query status](https://docs.aws.amazon.com/neptune/latest/userguide/sparql-api-status.md): Information about using the SPARQL query status HTTP API in Neptune. - [Query cancellation](https://docs.aws.amazon.com/neptune/latest/userguide/sparql-api-status-cancel.md): Information about using the SPARQL query cancellation HTTP API in Neptune. - [Graph store protocol](https://docs.aws.amazon.com/neptune/latest/userguide/sparql-graph-store-protocol.md): Information about using the SPARQL graph-store HTTP API in Neptune. ### [SPARQL explain](https://docs.aws.amazon.com/neptune/latest/userguide/sparql-explain.md) Use the SPARQL explain feature in Neptune to understand and improve your query execution. - [SPARQL query engine](https://docs.aws.amazon.com/neptune/latest/userguide/sparql-explain-engine.md): Understand how the Neptune SPARQL query engine works. - [Using SPARQL explain](https://docs.aws.amazon.com/neptune/latest/userguide/sparql-explain-using.md): Use SPARQL explain to analyze and improve query execution in Neptune. - [explain Examples](https://docs.aws.amazon.com/neptune/latest/userguide/sparql-explain-examples.md): Understand the various kinds of output that you can produce by invoking the SPARQL explain feature in Neptune. - [explain operators](https://docs.aws.amazon.com/neptune/latest/userguide/sparql-explain-operators.md): Description of operators and parameters for the Amazon Neptune SPARQL explain feature. - [explain Limitations](https://docs.aws.amazon.com/neptune/latest/userguide/sparql-explain-limitations.md): Limitations of the release of the SPARQL explain feature in Neptune. - [SPARQL SERVICE Extension](https://docs.aws.amazon.com/neptune/latest/userguide/sparql-service.md): Use the SPARQL SERVICE keyword in Neptune to federate queries. ## [Visualization tools](https://docs.aws.amazon.com/neptune/latest/userguide/visualization-tools.md) - [Graph-explorer](https://docs.aws.amazon.com/neptune/latest/userguide/visualization-graph-explorer.md): Graph-explorer is an open-source low-code visual exploration tool for graph data, available under the Apache-2.0 license. - [Tom Sawyer Software](https://docs.aws.amazon.com/neptune/latest/userguide/visualization-tom-sawyer.md): Tom Sawyer Perspectives is a low-code graph and data visualization and analysis development platform for data stored in Amazon Neptune. - [Cambridge Intelligence](https://docs.aws.amazon.com/neptune/latest/userguide/visualization-cambridge-intelligence.md): Cambridge Intelligence provides data visualization technologies for exploring and understanding Amazon Neptune data. - [Graphistry](https://docs.aws.amazon.com/neptune/latest/userguide/visualization-graphistry.md): Graphistry is a visual graph intelligence platform that leverages GPU acceleration for rich visual experiences. - [metaphacts](https://docs.aws.amazon.com/neptune/latest/userguide/visualization-metaphacts.md): metaphacts offers a flexible, open platform for describing and querying graph data and for visualizing and interacting with knowledge graphs. - [G.V() graph database client](https://docs.aws.amazon.com/neptune/latest/userguide/gv-tool.md): G.V() is a comprehensive graph database client for Amazon Neptune that helps you explore, visualize, and interact with your graph data. - [Linkurious](https://docs.aws.amazon.com/neptune/latest/userguide/visualization-Linkurious.md): Linkurious provides technical and non-technical users with a next-generation, enterprise-ready contextual decision intelligence platform powered by native graph technology. - [Graph.Build](https://docs.aws.amazon.com/neptune/latest/userguide/visualization-graph.build.md): In any domain, collaboration with subject matter experts is key to designing graph models that effectively address specific use cases. ## [Exporting data](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-data-export.md) - [Native export](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-native-export.md): Use the Neptune export API to export RDF data from your Neptune database to Amazon S3. ### [Exporting Gremlin query results to Amazon S3](https://docs.aws.amazon.com/neptune/latest/userguide/exporting-gremlin.md) Starting in engine release 1.4.3.0, Amazon Neptune supports exporting Gremlin query results directly to Amazon S3. - [Granting access for Gremlin Amazon S3 export feature](https://docs.aws.amazon.com/neptune/latest/userguide/granting-access-gremlin.md): Required IAM policies ### [External neptune-export tool](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-export.md) The open-source neptune-export tool is a separate application from Neptune. ### [Neptune-Export service](https://docs.aws.amazon.com/neptune/latest/userguide/export-service.md) You can use the following steps to export data from your Neptune DB cluster to Amazon S3 using the Neptune-Export service: - [Run an export job](https://docs.aws.amazon.com/neptune/latest/userguide/export-service-run-export.md): The Outputs tab of the CloudFormation stack also includes the NeptuneExportApiUri. - [neptune-export utility](https://docs.aws.amazon.com/neptune/latest/userguide/export-utility.md): You can use the following steps to export data from your Neptune DB cluster to Amazon S3 using the neptune-export command-line utility: - [Exported files](https://docs.aws.amazon.com/neptune/latest/userguide/exported-files.md): When an export is complete, the export files are published to the Amazon S3 location you have specified. ### [Export parameters](https://docs.aws.amazon.com/neptune/latest/userguide/export-parameters.md) Whether you are using the Neptune-Export service or the neptune-export command line utility, the parameters you use to control the export are mostly the same. - [params](https://docs.aws.amazon.com/neptune/latest/userguide/export-params-fields.md): The Neptune export params JSON object allows you to control the export, including the type and format of the exported data. - [Filtering examples](https://docs.aws.amazon.com/neptune/latest/userguide/export-filtering-examples.md): Here are examples that illustrate ways to filter the data that is exported. - [Troubleshooting](https://docs.aws.amazon.com/neptune/latest/userguide/export-troubleshooting.md): The Amazon Neptune export process uses AWS Batch to provision the compute and storage resources necessary to export your Neptune data. ## [Managing Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console.md) ### [Neptune Blue/Green solution](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-BG-deployments.md) Amazon Neptune engine upgrades can require application downtime because the database is unavailable while the updates are being installed and verified. - [Use CloudFormation to run the solution](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-BG-console-cfn.md): You can use AWS CloudFormation to deploy the Neptune Blue/Green solution. - [Monitoring progress](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-BG-monitoring.md): You can monitor the progress of the Neptune Blue/Green solution by going to the CloudWatch console and looking at logs in the /aws/neptune/(Neptune Blue/Green deployment ID) CloudWatch log group. - [Cutting over to the updated cluster](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-BG-cutover.md): Before promoting the green cluster to production, ensure that the commit difference between the blue and green clusters is zero and then disable all write traffic to the blue cluster. - [Cleanup](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-BG-cleanup.md): After you have promoted the staging (green) cluster to production, clean up the resources created by the Neptune Blue/Green solution: - [Best practices](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-BG-best-practices.md) - [Troubleshooting](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-BG-troubleshooting.md): The following information highlights issues that can arise during the Blue/Green solution deployment process, such as conflicts with existing clusters, the need to enable Neptune streams, ongoing bulk load operations, and version compatibility requirements. - [IAM user permissions](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-iam-user.md): To access the Neptune console to create and manage a Neptune DB cluster, you need to create an IAM user with all the necessary permissions. - [Parameter groups](https://docs.aws.amazon.com/neptune/latest/userguide/parameter-groups.md): Overview of parameter groups and how to create and edit them in Neptune. - [Parameters](https://docs.aws.amazon.com/neptune/latest/userguide/parameters.md): Parameters that you can use to configure Neptune. - [Launch using the console](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-launch-console.md): The easiest way to launch a new Neptune DB cluster is to use an CloudFormation template that creates all the required resources for you, as explained in . - [Stopping and starting a cluster](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-stop-start.md): Stop and start all DB instances in an Amazon Neptune cluster at once. - [Fast reset API](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-fast-reset.md): How to reset a Neptune DB cluster quickly and easily. - [Adding reader instances](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-add-replicas.md): Add Neptune read-replicas to a DB cluster to offload read workloads from the primary DB instance. - [Creating a reader instance](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-create-replica.md): After creating the primary instance for your Neptune DB cluster, you can add additional Neptune reader instances using the Neptune console. - [Modifying a DB Cluster](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-modify.md): When you modify a DB instance using the AWS Management Console, you can choose to apply the changes right away by selecting Apply Immediately. - [Performance and Scaling](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-performance-scaling.md): Neptune DB clusters and instances scale at three different levels: - [Auto-scaling](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-autoscaling.md): How to auto-scale the number of Neptune replicas. ### [Cluster maintenance](https://docs.aws.amazon.com/neptune/latest/userguide/cluster-maintenance.md) Neptune periodically performs maintenance on Neptune resources. - [Release types](https://docs.aws.amazon.com/neptune/latest/userguide/release-types.md): The four types of engine release that correspond to the four parts of an engine version number are as follows: - [Engine version life-spans](https://docs.aws.amazon.com/neptune/latest/userguide/engine-updates-eol-planning.md): Neptune engine versions almost always reach their end of life at the end of a calendar quarter. - [Managing engine updates](https://docs.aws.amazon.com/neptune/latest/userguide/engine-maintenance-management.md) - [Upgrade process](https://docs.aws.amazon.com/neptune/latest/userguide/engine-updates-manually.md) - [Upgrading to 1.2.0.0 or above](https://docs.aws.amazon.com/neptune/latest/userguide/engine-updates-1200-changes.md): Engine release 1.2.0.0 introduced several significant changes that can make upgrading from an earlier version more complicated than usual: ### [Update via CloudFormation](https://docs.aws.amazon.com/neptune/latest/userguide/cfn-engine-update.md) You can re-use the Neptune CloudFormation template that you used to create your Neptune DB Cluster to update its engine version. - [1.2.0.1 to 1.2.0.2](https://docs.aws.amazon.com/neptune/latest/userguide/cfn-engine-update-1201-1202.md): Find the DB cluster that you want to upgrade, and the template you used to create it. - [1.1.1.0 to 1.2.0.2, default](https://docs.aws.amazon.com/neptune/latest/userguide/cfn-engine-update-1110-1202-default.md): Find the DBCluster that you want to upgrade, and the template you used to create it. - [1.1.1.0 to 1.2.0.2, custom](https://docs.aws.amazon.com/neptune/latest/userguide/cfn-engine-update-1110-1202-custom.md): Find the DBCluster that you want to upgrade, and the template you used to create it. - [1.1.1.0 to 1.2.0.2, mixed](https://docs.aws.amazon.com/neptune/latest/userguide/cfn-engine-update-1110-1202-mixed.md): Find the DBCluster that you want to upgrade, and the template you used to create it. - [Cloning a DB Cluster](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-cloning.md): Using DB cloning, you can quickly and cost-effectively create clones of all your databases in Amazon Neptune. ### [Managing Instances](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances.md) The following sections have information on instance-level operations. - [T3 Burstable Instances](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-t3.md): A T3 burstable DB instance is the most cost-effective for development. - [Modifying an Instance](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-modify.md): Modify a Neptune DB instance and choose when to apply the changes. - [Renaming a Neptune DB Instance](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-rename.md): Rename a DB instance by using the Neptune console. - [Rebooting a DB instance](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-reboot.md): Reboot the DB instance for the changes to take effect by using the Neptune console. - [Deleting a DB Instance](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.md): Delete a Neptune DB instance by specifying the name of the instance with or without a final DB snapshot. ## [Neptune streams](https://docs.aws.amazon.com/neptune/latest/userguide/streams.md) ### [Using Streams](https://docs.aws.amazon.com/neptune/latest/userguide/streams-using.md) Enable change logging and get access to the change-log stream in Neptune. - [Enabling Streams](https://docs.aws.amazon.com/neptune/latest/userguide/streams-using-enabling.md): You can enable or disable Neptune Streams at any time by setting the neptune_streams DB cluster parameter. - [Disabling Streams](https://docs.aws.amazon.com/neptune/latest/userguide/streams-using-disabling.md): You can turn Neptune Streams off any time that it is running. - [Calling the Streams API](https://docs.aws.amazon.com/neptune/latest/userguide/streams-using-api-call.md): You access Neptune Streams using a REST API that sends an HTTP GET request to one of the following local endpoints: - [Streams Response](https://docs.aws.amazon.com/neptune/latest/userguide/streams-using-api-reponse.md): A response to a Neptune Streams REST API request has the following fields: - [Reading stream data](https://docs.aws.amazon.com/neptune/latest/userguide/streams-using-reading.md): The following examples show how to read records from the property graph stream endpoint. - [Streams Exceptions](https://docs.aws.amazon.com/neptune/latest/userguide/streams-using-api-exceptions.md): The following table describes Neptune Streams exceptions. - [Streams Record Formats](https://docs.aws.amazon.com/neptune/latest/userguide/streams-change-formats.md): The serialization formats for changes to Gremlin and SPARQL graph data in Neptune. - [Streams Examples](https://docs.aws.amazon.com/neptune/latest/userguide/streams-examples.md): Examples of accessing change-log stream data in Neptune. - [Neptune-to-Neptune Replication Setup](https://docs.aws.amazon.com/neptune/latest/userguide/streams-consumer-setup.md): You can use an CloudFormation template to set up the Neptune streams consumer application to support Neptune-to-Neptune replication. ### [Streams for disaster recovery](https://docs.aws.amazon.com/neptune/latest/userguide/streams-disaster-recovery.md) Using Neptune streams cross-region replication for disaster recovery. - [Replication setup](https://docs.aws.amazon.com/neptune/latest/userguide/streams-disaster-recovery-setup.md): Your primary production DB cluster resides in a VPC in a given source region. - [Other considerations](https://docs.aws.amazon.com/neptune/latest/userguide/streams-disaster-recovery-setup-other.md) ## [Neptune full text search](https://docs.aws.amazon.com/neptune/latest/userguide/full-text-search.md) ### [Full-text search setup](https://docs.aws.amazon.com/neptune/latest/userguide/full-text-search-cfn-setup.md) Amazon Neptune supports full-text search in Gremlin and SPARQL queries using Amazon OpenSearch Service (OpenSearch Service). - [CloudFormation template](https://docs.aws.amazon.com/neptune/latest/userguide/full-text-search-cfn-create.md) - [Existing databases](https://docs.aws.amazon.com/neptune/latest/userguide/full-text-search-cfn-enabling.md): These are the established approaches to enabling full text search on existing Amazon Neptune databases. - [Updating the poller](https://docs.aws.amazon.com/neptune/latest/userguide/full-text-search-cfn-update-poller.md): The following information outlines the steps needed to update the stream poller with the latest Lambda artifacts using the AWS management console. ### [Stopping and starting the poller](https://docs.aws.amazon.com/neptune/latest/userguide/full-text-search-using-pausing-poller.md) - [Pause the poller](https://docs.aws.amazon.com/neptune/latest/userguide/full-text-search-pause-poller.md) - [Re-enable the poller](https://docs.aws.amazon.com/neptune/latest/userguide/full-text-search-re-enable-poller.md) - [OpenSearch Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/full-text-search-serverless.md): Starting with engine release 1.3.0.0, Amazon Neptune supports using Amazon OpenSearch Service Serverless for full-text search in Gremlin and SPARQL queries. - [Querying with fine-grained access control](https://docs.aws.amazon.com/neptune/latest/userguide/full-text-search-fgac.md): If you have enabled fine-grained access control on your OpenSearch cluster, you need to enable IAM authentication in your Neptune database as well. - [Use of Lucene syntax](https://docs.aws.amazon.com/neptune/latest/userguide/full-text-search-lucene.md): OpenSearch supports using Apache Lucene syntax for query_string queries. - [Neptune Full-text search data model](https://docs.aws.amazon.com/neptune/latest/userguide/full-text-search-model.md): Overview of unified JSON document structure used by Neptune for storing SPARQL and Gremlin data in OpenSearch Service. - [Full-text search parameters](https://docs.aws.amazon.com/neptune/latest/userguide/full-text-search-parameters.md): Amazon Neptune uses the following parameters for specifying full-text OpenSearch queries in both Gremlin and SPARQL: ### [Non-string indexing](https://docs.aws.amazon.com/neptune/latest/userguide/full-text-search-non-string-indexing.md) How Neptune lets you index non-string values in OpenSearch. - [Updating an existing stack](https://docs.aws.amazon.com/neptune/latest/userguide/full-text-search-non-string-indexing-update.md): If you are already using Neptune full-text search, here are the steps you need to take to support non-string indexing: - [Excluding fields](https://docs.aws.amazon.com/neptune/latest/userguide/full-text-search-non-string-indexing-filters.md): There are two fields in the CloudFormation template details that let you specify property or predicate keys or datatypes to exclude from OpenSearch indexing: - [Datatype mappings](https://docs.aws.amazon.com/neptune/latest/userguide/full-text-search-non-string-indexing-mapping.md): New datatype mappings in OpenSearch are created based on the datatype being used in the property or object. - [Datatype validation](https://docs.aws.amazon.com/neptune/latest/userguide/full-text-search-data-validation.md) - [Sample queries](https://docs.aws.amazon.com/neptune/latest/userguide/full-text-search-non-string-examples.md): Neptune does not currently support OpenSearch range queries directly. - [Full-text-search query execution](https://docs.aws.amazon.com/neptune/latest/userguide/full-text-search-query-execution.md): How Neptune plans and executes full-text search queries. - [Sample SPARQL full-text search queries](https://docs.aws.amazon.com/neptune/latest/userguide/full-text-search-sparql-examples.md): The following are some sample SPARQL queries that use full-text search in Amazon Neptune. - [Sample Gremlin full-text search queries](https://docs.aws.amazon.com/neptune/latest/userguide/full-text-search-gremlin.md): NeptuneSearchStep enables full-text search queries for the part of a Gremlin traversal that is not converted into Neptune steps. - [Troubleshooting and metrics](https://docs.aws.amazon.com/neptune/latest/userguide/streams-consumer-troubleshooting.md) ## [AWS Lambda functions](https://docs.aws.amazon.com/neptune/latest/userguide/lambda-functions.md) - [Gremlin WebSocket connections](https://docs.aws.amazon.com/neptune/latest/userguide/lambda-functions-websocket-connections.md): If you use a Gremlin language variant to query Neptune, the driver connects to the database using a WebSocket connection. ### [Gremlin Lambda recommendations](https://docs.aws.amazon.com/neptune/latest/userguide/lambda-functions-gremlin-recommendations.md) We now recommend using a single connection and graph traversal source for the entire lifetime of a Lambda execution context, rather than one for each function invocation (every function invocation handles only one client request). - [Write-request recommendations](https://docs.aws.amazon.com/neptune/latest/userguide/lambda-functions-gremlin-write-recommendations.md): If your Lambda function modifies graph data, consider adopting a back-off-and-retry strategy to handle the following exceptions. - [Read-request recommendations](https://docs.aws.amazon.com/neptune/latest/userguide/lambda-functions-gremlin-read-recommendations.md): If you have one or more read replicas in your cluster, it's a good idea to balance read requests across these replicas. - [Cold-start latency](https://docs.aws.amazon.com/neptune/latest/userguide/lambda-functions-gremlin-cold-start-recommendations.md): The first time an AWS Lambda function is invoked is referred to as a cold start. - [Creating a Lambda Function](https://docs.aws.amazon.com/neptune/latest/userguide/get-started-cfn-lambda.md): You can use an CloudFormation template to create an AWS Lambda function that can access Neptune. - [Lambda function examples](https://docs.aws.amazon.com/neptune/latest/userguide/lambda-functions-examples.md): The following example AWS Lambda functions, written in Java, JavaScript and Python, illustrate upserting a single vertex with a randomly generated ID using the mergeV() step (see ). ## [Neptune machine learning](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning.md) ### [Neptune ML setup](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-setup.md) The easiest way to get started with Neptune ML is to use the CloudFormation quick-start template. - [Setup using CloudFormation](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-quick-start.md): The easiest way to get started with Neptune ML is to use the CloudFormation quick-start template. ### [Manual setup](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-manual-setup.md) What you need to do to set up Neptune ML without using the quick-start CloudFormation template. - [Manual ML notebook setup](https://docs.aws.amazon.com/neptune/latest/userguide/ml-manual-setup-notebooks.md): Neptune SageMaker AI notebooks come pre-loaded with a variety of sample notebooks for Neptune ML. - [Using the AWS CLI](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-cluster-setup.md): In addition to the CloudFormation quick-start template and the AWS Management Console, you can also set up Neptune ML using the AWS CLI. ### [Using Neptune ML](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-overview.md) The Neptune ML feature in Amazon Neptune provides a streamlined workflow for leveraging machine learning models within a graph database. - [Handling evolving data](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-overview-evolving-data.md): With a continuously changing graph, you may want to create new batch predictions periodically using fresh data. - [Updating the model artifacts](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-overview-evolving-data-incremental.md): While you update model artifacts simply by re-running the steps one through three (from Data export and configuration to Model transform), Neptune ML supports simpler ways to update your batch ML predictions using new data. - [Custom model workflow](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-overview-custom-model-workflow.md): Neptune ML lets you implement, train and deploy custom models of your own for any of the tasks that Neptune ML supports. - [Instance selection](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-on-graphs-instance-selection.md): The different stages of Neptune ML processing use different SageMaker AI instances. ### [Data export](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-data-export.md) Neptune ML requires that you provide training data for the Deep Graph Library (DGL) to create and evaluate models. - [Neptune-Export examples](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-export-examples.md): This request exports property-graph training data for a node classification task: - [Params settings](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-params.md): The params object in an export request can contain various fields, as described in the params documentation. ### [AdditionalParams](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-additionalParams.md) The additionalParams object contains fields that you can use to specify machine-learning class labels and features for training purposes and guide the creation of a training data configuration file. - [Top-level neptune_ml fields](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-neptune_ml-top-level.md) - [targets](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-neptune_ml-targets.md): The targets field in a JSON training data export configuration contains an array of target objects that specify a training task and and the machine-learning class labels for training this task. - [features](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-neptune_ml-features.md): Property values and RDF literals come in different formats and data types. - [Examples](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-data-export-additionalParams-examples.md): The following examples demonstrate how to utilize the "additionalParams" feature in property-graph and RDF data models to configure various aspects of the model training process for a Neptune ML application. ### [Data processing](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-on-graphs-processing.md) The data-processing step takes the Neptune graph data created by the export process and creates the information that is used by the Deep Graph Library (DGL) during training. - [Feature encoding](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-feature-encoding.md): Property values come in different formats and data types. ### [Editing a training data file](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-processing-training-config-file.md) The Neptune export process exports Neptune ML data from a Neptune DB cluster into an S3 bucket. - [Sample file](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-processing-training-config-file-example.md): Here is a sample training data configuration file that describes a graph for a node-classification task: - [File structure](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-processing-training-config-file-structure.md): The training configuration file refers to CSV files saved by the export process in the nodes/ and edges/ folders. ### [Model training](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-on-graphs-model-training.md) After you have processed the data that you exported from Neptune for model training, you can start a model-training job using a command like the following: - [Models and training](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-models-and-training.md): Neptune ML uses Graph Neural Networks (GNN) to create models for the various machine-learning tasks. - [Customizing hyperparameters](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-customizing-hyperparams.md): When you start a Neptune ML model-training job, Neptune ML automatically uses the information inferred from the preceding data-processing job. - [Training best practices](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-improve-model-performance.md): There are things you can do to improve the performance of Neptune ML models. - [Model transform](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.md): Using the Neptune ML model transform command, you can compute model artifacts like node embeddings on processed graph data using pre-trained model parameters. - [Model artifacts](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-artifacts.md): After model training, Neptune ML uses the best trained model parameters to generate model artifacts that are necessary for launching the inference endpoint and providing model predictions. ### [Custom models](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-custom-models.md) - [Custom model overview](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-custom-model-overview.md) - [Custom model development](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-custom-model-development.md): A good way to start custom model development is by following Neptune ML toolkit examples to structure and write your training module. - [Inference endpoint](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-on-graphs-inference-endpoint.md): An inference endpoint lets you query one specific model that the model-training process constructed. ### [Inference queries](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-inference-queries.md) Query the Neptune ML inference endpoint using Gremlin or SPARQL. ### [Gremlin inference queries](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-gremlin-inference-queries.md) Query the Neptune ML inference endpoint using the Gremlin query language. - [Inference query predicates](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-gremlin-inference-query-predicates.md) - [Node classification](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-gremlin-vertex-classification-queries.md): For Gremlin node classification in Neptune ML: - [Node regression](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-gremlin-vertex-regression-queries.md): Node regression is similar to node classification, except that the value inferred from the regression model for each node is numeric. - [Edge classification](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-gremlin-edge-classification-queries.md): For Gremlin edge classification in Neptune ML: - [Edge regression](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-gremlin-edge-regression.md): Edge regression is similar to edge classification, except that the value inferred from the ML model is numeric. - [Link prediction](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-gremlin-link-prediction-queries.md): Link-prediction models can solve problems such as the following: - [Exceptions list](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-gremlin-exceptions.md): This is a comprehensive list of exceptions that can occur when executing Neptune ML Gremlin inference queries. ### [SPARQL inference queries](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-sparql-inference-queries.md) Query the Neptune ML inference endpoint using the SPARQL query language. - [SPARQL inference query predicates](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-sparql-inference-query-predicates.md): The following predicates are used with SPARQL inference: - [Object classification](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-sparql-inference-object-classification.md): For SPARQL object classification in Neptune ML, the model is trained on one of the predicate values. - [Object regression](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-sparql-inference-object-regression.md): Object regression is similar to object classification, except that a numerical predicate value inferred from the regression model for each node. - [Object prediction](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-sparql-inference-object-prediction.md): Object prediction predicts the object value for a given subject and predicate. - [Subject prediction](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-sparql-inference-subject-prediction.md): Subject prediction predicts the subject given a predicate and an object. - [Exceptions list](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-sparql-exceptions.md) ### [Neptune ML API](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-reference.md) - [The dataprocessing command](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.md): You use the Neptune ML dataprocessing command to create a data processing job, check its status, stop it, or list all active data-processing jobs. - [The modeltraining command](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.md): You use the Neptune ML modeltraining command to create a model training job, check its status, stop it, or list all active model-training jobs. - [The modeltransform command](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltransform.md): You use the Neptune ML modeltransform command to create a model transform job, check its status, stop it, or list all active model-transform jobs. - [The endpoints command](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.md): You use the Neptune ML endpoints command to create an inference endpoint, check its status, delete it, or list existing inference endpoints. - [Exceptions](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-exceptions.md): All Neptune ML management API exceptions return a 400 HTTP code. - [Limits](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-limits.md) ## [Monitoring Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/monitoring.md) - [Instance Status](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-status.md): How to check the status of a DB instance in Neptune. ### [Using CloudWatch](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch.md) View and monitor metrics for your Neptune DB instances using the CloudWatch console, CloudWatch CLI, or programmatically with the CloudWatch API. - [Monitor instance performance](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-monitoring-instances.md): You can use CloudWatch metrics in Neptune to monitor what is happening on your DB instances and keep track of the query queue length as observed by the database. - [Neptune Metrics](https://docs.aws.amazon.com/neptune/latest/userguide/cw-metrics.md) - [Neptune Dimensions](https://docs.aws.amazon.com/neptune/latest/userguide/cw-dimensions.md): The metrics for Amazon Neptune are qualified by the values for the account, graph name, or operation. - [Audit Logs with Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/auditing.md): Audit the activity in your Neptune DB cluster. - [Neptune CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.md): Publish audit and error logs from Neptune to CloudWatch Logs. - [Notebook CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/notebook-logs.md): How to enable CloudWatch Logs for a Neptune notebook. - [Slow-query logs](https://docs.aws.amazon.com/neptune/latest/userguide/slow-query-logs.md): How to use slow-query logging in Neptune. ### [Logging Neptune API Calls with AWS CloudTrail](https://docs.aws.amazon.com/neptune/latest/userguide/cloudtrail.md) Learn about logging Amazon Neptune with AWS CloudTrail. - [Neptune Information in CloudTrail](https://docs.aws.amazon.com/neptune/latest/userguide/cloudtrail.CloudTrail.md): CloudTrail is enabled on your AWS account when you create the account. - [Understanding log file entries](https://docs.aws.amazon.com/neptune/latest/userguide/cloudtrail.CloudTrail_Events.md): A trail is a configuration that enables delivery of events as log files to an Amazon S3 bucket that you specify. ### [Events](https://docs.aws.amazon.com/neptune/latest/userguide/events.md) View Neptune events in the console, AWS CLI, or API, and subscribe to event notifications using Amazon SNS. - [Categories and messages](https://docs.aws.amazon.com/neptune/latest/userguide/event-lists.md): Neptune generates a significant number of events in categories that you can subscribe to using the Neptune console. - [Viewing events](https://docs.aws.amazon.com/neptune/latest/userguide/viewing-events.md): View Neptune events in the console, AWS CLI, or API. - [Subscribing to events](https://docs.aws.amazon.com/neptune/latest/userguide/events-subscribing.md): You can use the Neptune console to subscribe to event notifications, as follows: - [Manage subscriptions](https://docs.aws.amazon.com/neptune/latest/userguide/events-manage.md): If you choose Event subscriptions in the navigation pane of the Neptune console, you can view subscription categories and a list of your current subscriptions. ### [Tagging Neptune resources](https://docs.aws.amazon.com/neptune/latest/userguide/tagging.md) Use tags to manage access, control what actions can be applied to resources, and track costs by adding metadata to your Amazon Neptune resources. - [Tagging in the console](https://docs.aws.amazon.com/neptune/latest/userguide/tagging-console.md): The process to tag an Amazon Neptune resource is similar for all resources. - [Tagging with the CLI](https://docs.aws.amazon.com/neptune/latest/userguide/tagging-cli.md): You can add, list, or remove tags for a DB instance in Neptune using the AWS CLI. - [Tagging with the API](https://docs.aws.amazon.com/neptune/latest/userguide/tagging-api.md): You can add, list, or remove tags for a DB instance using the Neptune API. ### [Working with ARNs](https://docs.aws.amazon.com/neptune/latest/userguide/tagging-arns.md) Get the format for the Amazon Resource Name (ARN) for Neptune resources. - [Constructing an ARN](https://docs.aws.amazon.com/neptune/latest/userguide/tagging-arns-constructing.md): You can construct an ARN for an Amazon Neptune resource using the following syntax. ## [Backing up and restoring](https://docs.aws.amazon.com/neptune/latest/userguide/backup-restore.md) - [Fault Tolerance](https://docs.aws.amazon.com/neptune/latest/userguide/backup-restore-overview-fault-tolerance.md): A Neptune DB cluster is fault tolerant by design. - [Backup metrics](https://docs.aws.amazon.com/neptune/latest/userguide/backup-restore-overview-metrics.md): You can use the Amazon CloudWatch metrics TotalBackupStorageBilled, SnapshotStorageUsed, and BackupRetentionPeriodStorageUsed to review and monitor the amount of storage used by your Neptune backups, as follows: - [Restoring Data](https://docs.aws.amazon.com/neptune/latest/userguide/backup-restore-overview-restore.md): You can recover your data by creating a new Neptune DB cluster from the backup data that Neptune retains, or from a DB cluster snapshot that you have saved. - [Backup window](https://docs.aws.amazon.com/neptune/latest/userguide/backup-restore-overview-backup-window.md): Automated backups occur daily during the preferred backup window. - [Creating a Snapshot](https://docs.aws.amazon.com/neptune/latest/userguide/backup-restore-create-snapshot.md): Create a DB cluster snapshot by identifying which DB cluster you are going to back up and give that DB cluster snapshot a name. - [Restoring from a Snapshot](https://docs.aws.amazon.com/neptune/latest/userguide/backup-restore-restore-snapshot.md): Restore a Neptune DB cluster from a DB cluster snapshot. - [Copying a Snapshot](https://docs.aws.amazon.com/neptune/latest/userguide/backup-restore-copy-snapshot.md): Copy a Neptune snapshot. - [Sharing a Snapshot](https://docs.aws.amazon.com/neptune/latest/userguide/backup-restore-share-snapshot.md): Share a manual DB cluster snapshot so that other AWS accounts can copy or restore a DB instance from it. - [Deleting a Snapshot](https://docs.aws.amazon.com/neptune/latest/userguide/backup-restore-delete-snapshot.md): Delete a Neptune snapshot. ## [Best practices](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices.md) ### [Basic operational guidelines](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-general-basic.md) The following are basic operational guidelines that you should follow when working with Neptune. - [Security](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-general-security.md): Use AWS Identity and Access Management (IAM) accounts to control access to Neptune API actions. - [Using Metrics](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-general-metrics.md): To identify performance issues caused by insufficient resources and other common bottlenecks, you can monitor the metrics available for your Neptune DB cluster. ### [Gremlin (General)](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-gremlin.md) Follow these recommendations when using the Gremlin graph traversal language with Neptune. - [Heartbeat Configuration](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-gremlin-heartbeat-serverless.md): When using Gremlin WebSocket clients with Neptune Serverless, you need to configure the client's ping interval appropriately to maintain stable connections during scaling events. - [Execution differences](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-gremlin-console-glv-differences.md): Gremlin provides multiple ways for clients to submit queries to the server. - [Multithreaded Writes](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-gremlin-multithreaded-writes.md): There are a few guidelines for multithreaded loading of data into Neptune using Gremlin. - [Pruning Records](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-gremlin-prune.md): You can prune stale records by storing the creation time as a property on vertices and dropping them periodically. - [datetime( )](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-gremlin-datetime.md): Neptune provides the datetime method for specifying dates and times for queries sent in the Gremlin Groovy variant. - [Native Date and Time](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-gremlin-datetime-glv.md): If you are using a Gremlin Language Variant (GLV), you must use the native date and time classes and functions provided by the programming language for Gremlin time data. ### [Gremlin (Java client)](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-gremlin-java-client.md) Follow these recommendations when using the Gremlin Java client with Neptune. - [Re-use the client object](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-gremlin-java-reuse.md): Re-use the same client (or GraphTraversalSource) object across multiple threads. - [Separate Clients for Reading and Writing](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-gremlin-java-separate.md): You can increase performance by only performing writes on the writer endpoint and reading from one or more read-only endpoints. - [Multiple replica endpoints](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-gremlin-java-multiple.md): When creating a Gremlin Java Cluster object, you can use the .addContactPoint() method to add multiple read replica instances to the connection pool's contact points. - [Close the client when finished](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-gremlin-java-close-connections.md): It is important to close the client when you are finished with it to ensure that the WebSocket connections are closed by the server and all resources associated with the connections are released. - [New connection after failover](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-gremlin-java-new-connection.md): In case of failover, the Gremlin Driver might continue connecting to the old writer because the cluster DNS name is resolved to an IP address. - [Set maxInProcessPerConnection = maxSimultaneousUsagePerConnection](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-gremlin-java-maxes.md): Both the maxInProcessPerConnection and the maxSimultaneousUsagePerConnection parameters are related to the maximum number of simultaneous queries you can submit on a single WebSocket connection. - [Send queries as bytecode](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-gremlin-java-bytecode.md): There are advantages to using bytecode rather than a string when submitting queries: - [Completely consume query results](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-gremlin-java-resultset.md): The client object should always completely consume the ResultSet (in the case of string-based submission), or the iterator returned by GraphTraversal. - [Bulk add vertices and edges](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-gremlin-java-batch-add.md): Every query to the Neptune DB runs in the scope of a single transaction, unless you use a session. - [Disable JVM DNS caching](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-gremlin-java-disable-dns-caching.md): In an environment where you want to load-balance requests across multiple read replicas, you need to disable DNS caching in the Java Virtual Machine (JVM) and provide Neptune's reader endpoint while creating the Cluster object. - [Per-query timeouts](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-gremlin-java-per-query-timeout.md): Neptune provides you with the ability to set a timeout for your queries using the parameter group option neptune_query_timeout (see ). - [Handling a TimeoutException](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-gremlin-java-exceptions-TimeoutException.md): The Gremlin Java client throws a java.util.concurrent.TimeoutException when a Gremlin request times out at the client itself while waiting for a slot in one of the WebSocket connections to become available. ### [openCypher and Bolt](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-opencypher.md) Follow these best practices when using the openCypher query language and Bolt protocol with Neptune. - [Prefer directed edges](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-opencypher-directed-edges.md): When Neptune performs query optimizations, bi-directional edges make it difficult to create optimal query plans. - [No concurrent transaction queries](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-opencypher-multiple-queries.md): Although the Bolt driver itself allows concurrent queries in a transaction, Neptune does not support multiple queries in a transaction running concurrently. - [Close driver objects](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-opencypher-close-driver.md): Be sure to close the client when you are finished with it, so that the Bolt connections are closed by the server and all resources associated with the connections are released. - [Use explicit transaction modes](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-opencypher-use-explicit-txs.md): When using transactions with Neptune and the Bolt driver, it is best to explicitly set the access mode for both read and write transactions to the right settings. - [Retry logic](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-opencypher-retry-logic.md): Not all exceptions should be retried. - [Using the SET clause](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-content-0.md): Instead of using multiple SET clauses to set individual properties, use a map to set multiple properties for an entity at once. - [Use parameterized queries](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-content-2.md): It is recommended to always use parameterized queries when querying using openCypher. - [UNWIND clase](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-content-3.md): Deep nested structure can restrict the ability of the query engine to generate an optimal query plan. - [Variable-Length Path (VLP) expressions](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-content-4.md): In Variable-Length Path (VLP) queries, the query engine optimizes the evaluation by choosing to start the traversal on the left or right side of the expression. - [Use granular relationship names](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-content-5.md): When optimizing for performance, using relationship labels that are exclusive to node patterns allows the removal of label filtering on nodes. - [Specify edge labels](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-content-6.md): It is recommended to provide an edge label where possible when specifying an edge in a pattern. - [Avoid the WITH clause](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-content-7.md): The WITH clause in openCypher acts as a boundary where everything before it executes, and then the resulting values are passed to the remaining portions of the query. - [Restrictive filters](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-content-8.md): In all scenarios, early placement of filters in the query helps in reducing the intermediate solutions a query plan must consider. - [Explicitly check properties](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-content-9.md): Based on openCypher semantics, when a property is accessed it is equivalent to an optional join and must retain all rows even if the property does not exist. - [Avoid named path](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-content-10.md): Named path in a query always comes at an additional cost, which can add penalties in terms of higher latency and memory usage. - [Avoid COLLECT(DISTINCT())](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-content-11.md) - [Prefer the properties function](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-content-12.md): The properties() function is used to return a map containing all properties for an entity, and is much more efficient than returning properties individually. - [Static computations](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-content-13.md): It is recommended to resolve static computations (simple mathematical/string operations) on the client-side. - [Batching inputs](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-content-14.md): Whenever the same query needs to be executed for different inputs, instead of executing one query per input, it would be much more performant to run a query for a batch of inputs. - [Prefer custom IDs](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-content-15.md): Neptune allows users to explicitly assign IDs on nodes and relationships. - [Avoid ~id computations](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-content-16.md): When using custom IDs in the queries, always perform static computations outside the queries and provide these values in the parameters. - [Updating/Merging multiple nodes](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-merge-multiple-nodes.md): When running MERGE or CREATE queries on multiple nodes it is recommended to use an UNWIND in combination with a single MERGE/CREATE clause versus using a MERGE/CREATE clause for each node. ### [SPARQL](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-sparql.md) Follow these best practices when using the SPARQL query language with Neptune. - [Query All Named Graphs](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-sparql-query.md): Amazon Neptune associates every triple with a named graph. - [Specify a Named Graph to Load](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-sparql-graph.md): Amazon Neptune associates every triple with a named graph. - [FILTER vs. VALUES](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-sparql-batch.md): There are three basic ways to inject values in SPARQL queries:   FILTER,   FILTER...IN,   and   VALUES. ### [Amazon ECS and Amazon EKS](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-ecs-eks.md) Running your graph application in containers on Amazon Elastic Container Service (Amazon ECS) or Amazon Elastic Kubernetes Service (Amazon EKS) introduces considerations that don't apply to traditional long-running server deployments. - [Connection lifecycle](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-ecs-eks-connections.md): Managing connections to Neptune effectively is essential in containerized environments where containers (pods in Kubernetes) start, stop, and scale frequently. - [Host replacement](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-ecs-eks-host-replacement.md): When Neptune replaces a host (for example, during maintenance or failover), existing connections to that host become invalid. - [Networking and IAM](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-ecs-eks-networking-iam.md): Containerized deployments on Amazon ECS or Amazon EKS require correct network configuration and IAM credential management to connect to Neptune. - [AWS CLI and SDKs](https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-cli-sdk.md): By default, the AWS CLI and AWS SDKs time out after 60 seconds and automatically retry failed requests. ## [Tools and utilities](https://docs.aws.amazon.com/neptune/latest/userguide/tools.md) ### [GraphQL utility](https://docs.aws.amazon.com/neptune/latest/userguide/tools-graphql.md) Learn about using the GraphQL utility when working with Amazon Neptune. - [Installation and setup](https://docs.aws.amazon.com/neptune/latest/userguide/tools-graphql-setup.md): If you're going to use the utility with an existing Neptune database, you need it to be able to connect to the database endpoint. - [Using existing data](https://docs.aws.amazon.com/neptune/latest/userguide/tools-graphql-scan-existing.md): Whether you are familiar with GraphQL or not, the command below is the fastest way to create a GraphQL API. - [Using a schema with no directives](https://docs.aws.amazon.com/neptune/latest/userguide/tools-graphql-start-from-schema.md): You can start from an empty Neptune database and use a GraphQL schema with no directives to create the data and query it. - [Working with directives](https://docs.aws.amazon.com/neptune/latest/userguide/tools-graphql-schema-with-directives.md): You can start from a GraphQL schema that already has directives, using a command like the following: - [Command-line arguments](https://docs.aws.amazon.com/neptune/latest/userguide/tools-graphql-cmd-line-args.md) - [Nodestream](https://docs.aws.amazon.com/neptune/latest/userguide/tools-Nodestream.md): Nodestream is a framework for dealing with semantically modeling data as a graph. ## [Neptune Errors](https://docs.aws.amazon.com/neptune/latest/userguide/errors.md) - [Insufficient DB instances available](https://docs.aws.amazon.com/neptune/latest/userguide/insufficientDBInstancesAvailable.md): The InsufficientDBInstanceCapacity error can be returned when you try to create, start, or modify a DB instance. - [Engine Error Codes](https://docs.aws.amazon.com/neptune/latest/userguide/errors-engine-codes.md): Amazon Neptune endpoints return the standard errors for Gremlin and SPARQL when encountered. - [API Errors](https://docs.aws.amazon.com/neptune/latest/userguide/CommonErrors.md): These Amazon Neptune errors are associated with the APIs for creating and modifying Neptune resources with the AWS SDK and AWS CLI. - [Loader Errors](https://docs.aws.amazon.com/neptune/latest/userguide/loader-message.md): The following messages are returned by the status endpoint of the Neptune Loader. ## [Engine releases](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases.md) - [Release: 1.4.8.0 (2026-07-27)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.4.8.0.md): Amazon Neptune engine update, version 1.4.8.0 on 2026-07-27. - [Release: 1.4.7.1 (2026-09-18)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.4.7.1.md): Amazon Neptune engine update, version 1.4.7.1 on 2026-09-18. - [Release: 1.4.7.0 (2026-03-03)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.4.7.0.md): Amazon Neptune engine update, version 1.4.7.0 on 2026-03-03. - [Release: 1.4.6.3 (2025-12-18)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.4.6.3.md): Amazon Neptune engine update, version 1.4.6.3 on 2025-12-18. - [Release: 1.4.6.2 (2025-11-18)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.4.6.2.md): Amazon Neptune engine update, version 1.4.6.2 on 2025-11-18. - [Release: 1.4.6.1 (2025-09-18)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.4.6.1.md): Amazon Neptune engine update, version 1.4.6.1 on 2025-09-18. - [Release: 1.4.6.0 (2025-09-02)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.4.6.0.md): Amazon Neptune engine update, version 1.4.6.0 on 2025-09-02. - [Release: 1.4.5.1 (2025-06-30)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.4.5.1.md): Amazon Neptune engine update, version 1.4.5.1 on 2025-06-30. - [Release: 1.4.5.0 (2025-04-09)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.4.5.0.md): Amazon Neptune engine update, version 1.4.5.0 on 2025-04-09. - [Release: 1.4.4.0 (2025-02-24)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.4.4.0.md): Amazon Neptune engine update, version 1.4.4.0 on 2025-02-24. - [Release: 1.4.3.0 (2025-01-21)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.4.3.0.md): Amazon Neptune engine update, version 1.4.3.0 on 2025-01-21. - [Release: 1.4.2.0 (2024-12-19)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.4.2.0.md): Amazon Neptune engine update, version 1.4.2.0 on 2024-12-19. - [Release: 1.4.1.0 (2024-11-21)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.4.1.0.md): Amazon Neptune engine update, version 1.4.1.0 on 2024-11-21. - [Release: 1.4.0.0 (2024-11-06)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.4.0.0.md): Amazon Neptune engine update, version 1.4.0.0 on 2024-11-06. - [Release: 1.3.4.0 (2024-10-01)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.3.4.0.md): Amazon Neptune engine update, version 1.3.4.0 on 2024-10-01. - [Release: 1.3.3.0 (2024-08-05)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.3.3.0.md): Amazon Neptune engine update, version 1.3.3.0 on 2024-08-05. - [Release: 1.3.2.1 (2024-06-20)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.3.2.1.md): Amazon Neptune engine update, version 1.3.2.1 on 2024-06-20. - [Release: 1.3.2.0 (2024-06-10)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.3.2.0.md): Amazon Neptune engine update, version 1.3.2.0 on 2024-06-10. - [Release: 1.3.1.0 (2024-03-06)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.3.1.0.md): Amazon Neptune engine update, version 1.3.1.0 on 2024-03-06. - [Release: 1.3.0.0 (2023-11-15)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.3.0.0.md): Amazon Neptune engine update, version 1.3.0.0 on 2023-11-15. - [Release: 1.2.1.2 (2024-08-05)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.1.2.md): Amazon Neptune engine update, version 1.2.1.2 on 2024-08-05. - [Release: 1.2.1.1 (2024-03-11)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.1.1.md): Amazon Neptune engine update, version 1.2.1.1 on 2024-03-11. ### [Release: 1.2.1.0 (2023-03-08)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.1.0.md) Amazon Neptune engine update, version 1.2.1.0 on 2023-03-08. - [Release: 1.2.1.0.R7 (2023-10-06)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.1.0.R7.md): Amazon Neptune engine update, version 1.2.1.0.R7 on 2023-10-06. - [Release: 1.2.1.0.R6 (2023-09-12)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.1.0.R6.md): Amazon Neptune engine update, version 1.2.1.0.R6 on 2023-09-12. - [Release: 1.2.1.0.R5 (2023-09-02)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.1.0.R5.md): Amazon Neptune engine update, version 1.2.1.0.R5 on 2023-09-02. - [Release: 1.2.1.0.R4 (2023-08-10)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.1.0.R4.md): Amazon Neptune engine update, version 1.2.1.0.R4 on 2023-08-10. - [Release: 1.2.1.0.R3 (2023-06-13)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.1.0.R3.md): Amazon Neptune engine update, version 1.2.1.0.R3 on 2023-06-13. - [Release: 1.2.1.0.R2 (2023-05-02)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.1.0.R2.md): Amazon Neptune engine update, version 1.2.1.0.R2 on 2023-05-02. ### [Release: 1.2.0.2 (2022-11-20)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.2.md) Amazon Neptune engine update, version 1.2.0.2 on 2022-11-20. - [Release: 1.2.0.2.R6 (2023-09-12)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.2.R6.md): Amazon Neptune engine update, version 1.2.0.2.R6 on 2023-09-12. - [Release: 1.2.0.2.R5 (2023-08-16)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.2.R5.md): Amazon Neptune engine update, version 1.2.0.2.R5 on 2023-08-16. - [Release: 1.2.0.2.R4 (2023-05-08)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.2.R4.md): Amazon Neptune engine update, version 1.2.0.2.R4 on 2023-05-08. - [Release: 1.2.0.2.R3 (2023-03-27)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.2.R3.md): Amazon Neptune engine update, version 1.2.0.2.R3 on 2023-03-27. - [Release: 1.2.0.2.R2 (2022-12-15)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.2.R2.md): Amazon Neptune engine update, version 1.2.0.2.R2 on 2022-12-15. ### [Release: 1.2.0.1 (2022-10-26)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.1.md) Amazon Neptune engine update, version 1.2.0.1 on 2022-10-26. - [Maintenance Release: 1.2.0.1.R3 (2023-09-27)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.1.R3.md): Amazon Neptune engine update, version 1.2.0.1.R3 on 2023-09-27. - [Maintenance Release: 1.2.0.1.R2 (2022-12-13)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.1.R2.md): Amazon Neptune engine update, version 1.2.0.1.R2 on 2022-12-13. ### [Release: 1.2.0.0 (2022-07-21)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.0.md) Amazon Neptune engine update, version 1.2.0.0 on 2022-07-21. - [Release: 1.2.0.0.R4 (2023-09-29)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.0.R4.md): Amazon Neptune engine update, version 1.2.0.0.R4 on 2023-09-29. - [Release: 1.2.0.0.R3 (2022-12-15)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.0.R3.md): Amazon Neptune engine update, version 1.2.0.0.R3 on 2022-12-15. - [Release: 1.2.0.0.R2 (2022-10-14)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.0.R2.md): Amazon Neptune engine update, version 1.2.0.0.R2 on 2022-10-14. ### [Release: 1.1.1.0 (2022-04-19)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.1.1.0.md) Amazon Neptune engine update, version 1.1.1.0 on 2022-04-19. - [Release: 1.1.1.0.R7 (2023-01-23)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.1.1.0.R7.md): Amazon Neptune engine update, version 1.1.1.0.R7 on 2023-01-23. - [Release: 1.1.1.0.R6 (2022-09-23)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.1.1.0.R6.md): Amazon Neptune engine update, version 1.1.1.0.R6 on 2022-09-23. - [Release: 1.1.1.0.R5 (2022-07-21)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.1.1.0.R5.md): Amazon Neptune engine update, version 1.1.1.0.R5 on 2022-07-21. - [Release: 1.1.1.0.R4 (2022-06-23)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.1.1.0.R4.md): Amazon Neptune engine update, version 1.1.1.0.R4 on 2022-06-23. - [Release: 1.1.1.0.R3 (2022-06-07)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.1.1.0.R3.md): Amazon Neptune engine update, version 1.1.1.0.R3 on 2022-06-07. - [Maintenance release: 1.1.1.0.R2 (2022-05-16)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.1.1.0.R2.md): Amazon Neptune maintenance release engine update, version 1.1.1.0.R2 on 2022-05-16. ### [Release: 1.1.0.0 (2021-11-19)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.1.0.0.md) Amazon Neptune engine update, version 1.1.0.0 on 2021-11-19. - [Maintenance release: 1.1.0.0.R3 (2022-12-23)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.1.0.0.R3.md): Amazon Neptune maintenance release engine update, version 1.1.0.0.R3 on 2022-12-23. - [Maintenance release: 1.1.0.0.R2 (2022-05-16)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.1.0.0.R2.md): Amazon Neptune maintenance release engine update, version 1.1.0.0.R2 on 2022-05-16. ### [Release: 1.0.5.1 (2021-10-01)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.5.1.md) Amazon Neptune engine update, version 1.0.5.1 on 2021-10-01. - [Maintenance release: 1.0.5.1.R4 (2022-05-16)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.5.1.R4.md): Amazon Neptune maintenance release engine update, version 1.0.5.1.R4 on 2022-05-16. - [Release: 1.0.5.1.R3 (2022-01-13)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.5.1.R3.md): Amazon Neptune engine update, version 1.0.5.1.R3 on 2022-01-13. - [Release: 1.0.5.1.R2 (2021-10-26)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.5.1.R2.md): Amazon Neptune engine update, version 1.0.5.1.R2 on 2021-10-26. ### [Release: 1.0.5.0 (2021-07-27)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.5.0.md) Amazon Neptune engine update, version 1.0.5.0 on 2021-07-27. - [Maintenance release: 1.0.5.0.R5 (2022-05-16)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.5.0.R5.md): Amazon Neptune maintenance release engine update, version 1.0.5.0.R5 on 2022-05-16. - [Release: 1.0.5.0.R3 (2021-09-15)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.5.0.R3.md): Amazon Neptune engine update, version 1.0.5.0.R3 on 2021-09-15. - [Release: 1.0.5.0.R2 (2021-08-16)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.5.0.R2.md): Amazon Neptune engine update, version 1.0.5.0.R2 on 2021-08-16. ### [Release: 1.0.4.2 (2021-06-01)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.4.2.md) - [Release: 1.0.4.2.R5 (2021-08-16)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.4.2.R5.md): Amazon Neptune engine update, version 1.0.4.2.R5 on 2021-08-16. - [Release: 1.0.4.2.R4 (2021-07-23)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.4.2.R4.md): Amazon Neptune engine update, version 1.0.4.2.R4 on 2021-07-23. - [Release: 1.0.4.2.R3 (2021-06-28)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.4.2.R3.md): Amazon Neptune engine update, version 1.0.4.2.R3 on 2021-06-28. - [Release: 1.0.4.2.R2 (2021-06-01)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.4.2.R2.md): Amazon Neptune engine update, version 1.0.4.2.R2 on 2021-06-01. - [Release: 1.0.4.2.R1 (2021-05-27)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.4.2.R1.md): Amazon Neptune engine update, version 1.0.4.2.R1 on 2021-05-27. ### [Release: 1.0.4.1 (2020-12-08)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.4.1.md) Amazon Neptune engine update, version 1.0.4.1 on 2020-12-08. - [Release: 1.0.4.1.R1.1 (2021-03-22)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.4.1.R1.1.md): Amazon Neptune engine update, version 1.0.4.1.R1.1 on 2021-03-22. ### [Release: 1.0.4.1.R2 (2021-02-24)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.4.1.R2.md) Amazon Neptune engine update, version 1.0.4.1.R2 on 2021-02-24. - [Release: 1.0.4.1.R2.1 (2021-03-11)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.4.1.R2.1.md): Amazon Neptune engine update, version 1.0.4.1.R2.1 on 2021-03-11. ### [Release: 1.0.4.0 (2020-10-12)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.4.0.md) Amazon Neptune engine update, version 1.0.4.0 on 2020-10-12. - [Release: 1.0.4.0.R2 (2021-02-24)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.4.0.R2.md): Amazon Neptune engine update, version 1.0.4.0.R2 on 2021-02-24. ### [Release: 1.0.3.0 (2020-08-03)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.3.0.md) Amazon Neptune engine update, version 1.0.3.0 on 2020-08-03. - [Release: 1.0.3.0.R3 (2021-02-19)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.3.0.R3.md): Amazon Neptune engine update, version 1.0.3.0.R3 on 2021-02-19. - [Release: 1.0.3.0.R2 (2020-10-12)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.3.0.R2.md): Amazon Neptune engine update, version 1.0.3.0.R2 on 2020-10-12. ### [Release: 1.0.2.2 (2020-03-09)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.2.2.md) Amazon Neptune engine update, version 1.0.2.2 on 2020-03-09. - [Release: 1.0.2.2.R6 (2021-02-19)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.2.2.R6.md): Amazon Neptune engine update, version 1.0.2.2.R6 on 2021-02-19. - [Release: 1.0.2.2.R5 (2020-10-12)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.2.2.R5.md): Amazon Neptune engine update, version 1.0.2.2.R5 on 2020-10-12. - [Release: 1.0.2.2.R4 (2020-07-23)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.2.2.R4.md): Amazon Neptune engine update, version 1.0.2.2.R4 on 2020-07-23. - [Release: 1.0.2.2.R3 (2020-07-22)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.2.2.R3.md): Amazon Neptune engine update, version 1.0.2.2.R3 on 2020-07-22. - [Release: 1.0.2.2.R2 (2020-04-02)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.2.2.R2.md): Amazon Neptune engine update, version 1.0.2.2.R2 on 2020-04-02. ### [Release: 1.0.2.1 (2019-11-22)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.2.1.md) Amazon Neptune engine update, version 1.0.2.1 on 2019-11-22. - [Release: 1.0.2.1.R6 (2020-04-22)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.2.1.R6.md): Amazon Neptune engine update, version 1.0.2.1.R6 on 2020-04-22. - [Release: 1.0.2.1.R5 (2020-04-22)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.2.1.R5.md): Amazon Neptune engine update, version 1.0.2.1.R5 on 2020-04-22. - [Release: 1.0.2.1.R4 (2019-12-20)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.2.1.R4.md): Amazon Neptune engine update, version 1.0.2.1.R4 on 2019-12-20. - [Release: 1.0.2.1.R3 (2019-12-12)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.2.1.R3.md): Amazon Neptune engine update, version 1.0.2.1.R3 on 2019-12-12. - [Release: 1.0.2.1.R2 (2019-11-25)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.2.1.R2.md): Amazon Neptune engine update, version 1.0.2.1.R2 on 2019-11-25. ### [Release: 1.0.2.0 (2019-11-08)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.2.0.md) Amazon Neptune engine update, version 1.0.2.0 on 2019-11-08. - [Release: 1.0.2.0.R3 (2020-05-05)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.2.0.R3.md): Amazon Neptune engine update, version 1.0.2.0.R3 on 2020-05-05. - [Release: 1.0.2.0.R2 (2019-11-21)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.2.0.R2.md): Amazon Neptune engine update, version 1.0.2.0.R2 on 2019-11-21. - [Release: 1.0.1.2 (2020-06-10)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.1.2.md): Amazon Neptune engine update, version 1.0.1.2 on 2020-06-10. - [Release: 1.0.1.1 (2020-06-26)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.1.1.md): Amazon Neptune engine update, version 1.0.1.1 on 2020-06-26. ### [Release: 1.0.1.0 (2019-07-02)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.1.0.md) Amazon Neptune engine update, version 1.0.1.0 on 2019-07-02. - [Release 1.0.1.0.200502.0 (2019-10-31)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.1.0.200502.0.md): Amazon Neptune engine updates for 2019-10-31. - [Release 1.0.1.0.200463.0 (2019-10-15)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.1.0.200463.0.md): Amazon Neptune engine updates for 2019-10-15. - [Release 1.0.1.0.200457.0 (2019-09-19)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.1.0.200457.0.md): Amazon Neptune engine updates for 2019-09-19. - [Release 1.0.1.0.200369.0 (2019-08-13)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.1.0.200369.0.md): Amazon Neptune engine updates for 2019-08-13. - [Release 1.0.1.0.200366.0 (2019-07-26)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.1.0.200366.0.md): Amazon Neptune engine updates for 2019-07-26. - [Release 1.0.1.0.200348.0 (2019-07-02)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.1.0.200348.0.md): Amazon Neptune engine updates for 2019-07-02. ### [Earlier Releases](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-earlier.md) - [Release 1.0.1.0.200310.0 (2019-06-12)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.1.0.200310.0.md): Amazon Neptune engine updates for 2019-06-12. - [Release 1.0.1.0.200296.0 (2019-05-01)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.1.0.200296.0.md): Amazon Neptune engine updates for 2019-05-01. - [Release 1.0.1.0.200267.0 (2019-01-21)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.1.0.200267.0.md): Amazon Neptune engine updates for 2019-01-21. - [Release 1.0.1.0.200264.0 (2018-11-19)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.1.0.200264.0.md): Amazon Neptune engine updates for 2018-11-19. - [Release 1.0.1.0.200258.0 (2018-11-08)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.1.0.200258.0.md): Amazon Neptune engine updates for 2018-11-08. - [Release 1.0.1.0.200255.0 (2018-10-29)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.1.0.200255.0.md): Amazon Neptune engine updates for 2018-10-29. - [Release 1.0.1.0.200237.0 (2018-09-06)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.1.0.200237.0.md): Amazon Neptune engine updates for 2018-09-06. - [Release 1.0.1.0.200236.0 (2018-07-24)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.1.0.200236.0.md): Amazon Neptune engine updates for 2018-07-24. - [Release 1.0.1.0.200233.0 (2018-06-22)](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.0.1.0.200233.0.md): Amazon Neptune engine updates for 2018-06-22. ## [Management API reference](https://docs.aws.amazon.com/neptune/latest/userguide/api.md) - [Clusters](https://docs.aws.amazon.com/neptune/latest/userguide/api-clusters.md): This section describes Neptune DB cluster data types, along with the API for managing them. - [Global databases](https://docs.aws.amazon.com/neptune/latest/userguide/api-global-dbs.md): This section describes Neptune global database data types, along with the API for managing them. - [Instances](https://docs.aws.amazon.com/neptune/latest/userguide/api-instances.md): This section describes Neptune instance data types, along with the API for managing them. - [Parameters](https://docs.aws.amazon.com/neptune/latest/userguide/api-parameters.md): This section describes Neptune parameters and parameter group data types, along with the API for creating, deleting, updating, resetting, copying, and listing them. - [Subnets](https://docs.aws.amazon.com/neptune/latest/userguide/api-subnets.md): This section describes Neptune subnets and subnet group data types, along with the API for creating, deleting, updating, resetting, copying, and listing them. - [Snapshots](https://docs.aws.amazon.com/neptune/latest/userguide/api-snapshots.md): This section describes Neptune sanpshot data types, along with the API for managing them. - [Events](https://docs.aws.amazon.com/neptune/latest/userguide/api-events.md): This section describes Neptune event data types, along with the API for managing them. - [Other](https://docs.aws.amazon.com/neptune/latest/userguide/api-other-apis.md): This section describes various other Neptune data types, along with the API for managing them. - [Datatypes](https://docs.aws.amazon.com/neptune/latest/userguide/api-datatypes.md): This section describes various common Neptune data types. - [API Faults](https://docs.aws.amazon.com/neptune/latest/userguide/api-faults.md): This section describes Neptune exceptions raised by individual APIs. ## [Data API reference](https://docs.aws.amazon.com/neptune/latest/userguide/data-api.md) - [General](https://docs.aws.amazon.com/neptune/latest/userguide/data-api-dp-environment-APIs.md): Engine operations: - [Querying](https://docs.aws.amazon.com/neptune/latest/userguide/data-api-dp-queries.md): Gremlin query actions: - [Bulk loader](https://docs.aws.amazon.com/neptune/latest/userguide/data-api-dp-loader.md): Bulk-load actions: - [Streams](https://docs.aws.amazon.com/neptune/latest/userguide/data-api-dp-streams.md): Stream access actions: - [Statistics](https://docs.aws.amazon.com/neptune/latest/userguide/data-api-dp-statistics.md): This section describes. - [ML data processing](https://docs.aws.amazon.com/neptune/latest/userguide/data-api-dp-ml-data-processing.md): Data-processing actions: - [ML model training](https://docs.aws.amazon.com/neptune/latest/userguide/data-api-dp-ml-training.md): Model training actions: - [ML model transform](https://docs.aws.amazon.com/neptune/latest/userguide/data-api-dp-ml-transform.md): Model transform actions: - [ML Inference endpoint](https://docs.aws.amazon.com/neptune/latest/userguide/data-api-dp-inference.md): Inference endpoint actions: - [Exceptions](https://docs.aws.amazon.com/neptune/latest/userguide/data-api-dp-errors.md): Exceptions: ## Full content The entire guide is also available as a single markdown file, useful for feeding the full guide to an LLM in one pass: - [Complete guide (single file)](https://docs.aws.amazon.com/neptune/latest/userguide/full.md)