Deploy a Remote Onyx Database Server

A Step-by-Step Guide for Kotlin and Java

This tutorial provides a detailed walkthrough for deploying a Remote Database Server using the robust Onyx Database framework. You'll acquire the skills to define, initiate, connect to, and manage a remote server using the powerful Remote Persistence Manager Factory, with code examples in both Kotlin and Java.

Understanding Remote vs. Embedded Onyx Database Implementations

This guide emphasizes the Remote Onyx Database Server configuration. In contrast to the embedded database, which operates within your application's process for rapid data access but limited scalability, the remote server offers enhanced scalability and centralized data management. For those interested in the embedded approach, consult our detailedEmbedded Persistence Manager Guide.

Opting for a remote server setup facilitates seamless integration with multiple client applications, making it a superior choice for complex systems requiring centralized data management.

Why Choose a Remote Database for Your Application?

Deploying a Remote Database with Onyx enables your application to seamlessly access and manage data across diverse Java, Kotlin, or other JVM-based clients.

By utilizing the Remote Persistence Manager Factory, your application achieves streamlined connectivity to the remote server. This ensures efficient data operations and simplified management, regardless of the platform or service architecture. You gain the flexibility to access your data through various JVM-compatible languages, including Java and Kotlin.

Unlock the Power of a Serverless Architecture with Onyx Cloud Database

Beyond remote server setup, consider the advantages of the Onyx Cloud Database service. It offers a cutting-edge, serverless database solution that scales automatically with your needs.

  • Leverage the Onyx Cloud Database for a scalable, serverless database experience, eliminating manual server management.
  • Bolster data security and integrity with centralized, cloud-based data control.
  • Dynamically adjust resources based on your application's real-time demands.
  • Foster collaboration across multiple clients and users with a unified data source.
  • Simplify data backup and maintenance with fully managed cloud services.
  • Access your data programmatically via a robust web service API and JavaScript SDK, allowing for smooth integration with modern web applications.
Get Started with Onyx Cloud Database Now

Practical Example: Configuring Your Remote Onyx Database Server

Execute these steps to effectively define, launch, and connect to a remote database server, utilizing both Kotlin and Java code snippets for clarity.

Add Onyx Dependency

To start using Onyx Database, you need to add it as a dependency to your project. Choose the build tool you're using and add the corresponding snippet below.

1import org.gradle.kotlin.dsl.repositories
2import org.gradle.kotlin.dsl.dependencies
3
4repositories {
5    maven {
6        url = uri("https://maven.pkg.github.com/OnyxDevTools/onyx-database-parent")
7        credentials {
8            username = "github_username"
9            password = "github_access_token"
10        }
11    }
12}
13
14dependencies {
15    implementation("com.onyxdevtools:onyx-database:3.4.4") // Embedded Database
16    implementation("com.onyxdevtools:onyx-remote-database:3.4.4") // Remote Database Server
17    implementation("com.onyxdevtools:onyx-remote-driver:3.4.4") // Remote Database Client
18}

Make sure to replace github_username and github_access_token with your GitHub credentials. Also, the latest version of Onyx Database is 3.4.4.

1

Define the Remote Database Server

Initialize the <DatabaseServer by specifying the desired database path. This path dictates where your database files will reside. Ensure the directory is accessible or will be automatically created by the system.
1val database = DatabaseServer(DATABASE_PATH) 
2database.setCredentials(DATABASE_USERNAME, DATABASE_PASSWORD)
3database.port = 8080
4database.start()
5database.join()
2

Secure Your Database with Credentials

Enhance your database security by configuring the server with a unique username and password. This critical step guarantees that only authorized clients can establish a connection.
3

Configure the Server Port

Designate the port for your database server to listen for incoming client connections. While this guide uses the standard port 8080, you're free to select any available port that suits your infrastructure.
4

Launch the Database Server

Activate your database server by invoking the start() method. This initializes the server, preparing it to accept connections from your application clients.
5

Maintain Server Operation with Join

Employ the join() method to ensure your server process remains active. This keeps the server running continuously, allowing it to handle client requests without interruption.

Connecting to Your Remote Onyx Database

Once your remote server is operational, your application needs to establish a connection using the Remote Persistence Manager Factory. This factory acts as a bridge, facilitating seamless communication for CRUD operations and data management between your application and the remote database.

It's crucial to ensure that the server URL, port, and credentials provided during connection match those configured during the server setup. Below are examples demonstrating how to initialize the factory in both Kotlin and Java:

1

Initialize the Factory

Use the RemotePersistenceManagerFactory to establish a connection by providing the server URL, credentials, and other necessary configurations.
1// Specify server host
2val factory = RemotePersistenceManagerFactory("onx://localhost:8080") 
3factory.setCredentials(DATABASE_USERNAME, DATABASE_PASSWORD)
4factory.initialize()

Troubleshooting Common Issues

  • Server Startup Failures: Confirm the specified port is available and not in use by another process. Verify the database path's accuracy and accessibility.
  • Connection Refusal Errors: Double-check that the server is actively running and that your client is utilizing the correct server URL and port.
  • Credential Mismatches: Ensure the username and password used in both server and client configurations are identical.
  • Network Connectivity Problems: Investigate potential firewall rules or network policies that might be obstructing the connection between your client and the server.

Best Practices for Remote Database Management

  • Leverage Environment Variables: Securely store sensitive data, such as database credentials, in environment variables rather than hardcoding them within your application.
  • Implement Secure Connections: Utilize SSL/TLS encryption to protect data transmitted between the client and server, ensuring confidentiality and integrity.
  • Establish Regular Backup Routines: Schedule consistent backups of your database to safeguard against data loss and facilitate disaster recovery.
  • Monitor Server Performance: Employ monitoring tools to track server performance metrics, enabling proactive optimization and resource allocation.

Advance Your Onyx Expertise: Explore Further

Having successfully deployed your remote Onyx Database Server, it's time to delve deeper into the Onyx ecosystem. These recommended tutorials will further expand your knowledge and capabilities: