From 4a08a4113cb5b39ffcd70cf23666e20aa715b604 Mon Sep 17 00:00:00 2001 From: IgGusev Date: Fri, 24 Jan 2025 17:35:17 +0200 Subject: [PATCH] IGNITE-24306 Update README for 3.0 release (#5117) --- assembly/README.md | 43 ++++++------------------------------------- 1 file changed, 6 insertions(+), 37 deletions(-) diff --git a/assembly/README.md b/assembly/README.md index a2cd7c5440f..d3b7c05058b 100644 --- a/assembly/README.md +++ b/assembly/README.md @@ -1,47 +1,17 @@ -# Apache Ignite 3 Beta 1 +# Apache Ignite 3 Apache Ignite is a distributed database for high-performance computing with in-memory speed. Ignite 3 is the next generation of the platform that will support a modernized modular architecture, along with improved usability and developer experience. -The current beta version includes the following features: -* RPM and DEB packages: simplified installation and node management -with system services. -* Client's Partition Awareness: Clients are now aware of data distribution over the cluster nodes which helps avoid -additional network transmissions and lowers operations latency. -* C++ client: Basic C++ client, able to perform operations on data. -* Autogenerated values: now a function can be specified as a default value generator during a table creation. -Currently only rand_uuid is supported. -* SQL Transactions. -* Transactional Protocol: improved locking model, multi-version based -lock-free read-only transactions. -* Storage: A number of improvements to memory-only and on-disk engines -based on Page Memory. -* Indexes: Basic functionality, hash and sorted indexes. -* Client logging: A LoggerFactory may be provided during client -creation to specify a custom logger for logs generated by the client. -* Metrics framework: Collection and export of cluster metrics. - - ## Installation -1. Download Ignite 3 Beta 1: - ``` - curl -L "https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-beta1/ignite3-3.0.0-beta1.zip" -o ignite3-3.0.0-beta1.zip - ``` -2. Unzip the downloaded file: - ``` - unzip ignite3-3.0.0-beta1.zip && cd ignite3-db-3.0.0-beta1 - ``` +1. Download Ignite 3 from the link:https://ignite.apache.org/download.cgi[Ignite website]. +2. Unzip the downloaded file. 3. Add your installation directory to the PATH environment variable: ``` export IGNITE_HOME=$(pwd) - ``` -4. (optional) If you start the cluster locally then install the core artifacts: - ``` - sh $IGNITE_HOME/bin/ignite3-db.sh start - ``` ## Running Examples @@ -60,17 +30,16 @@ To run any other example, do the following: 1. Import the examples project into your IDE. 2. Start a server node using the startup script: ``` - sh $IGNITE_HOME/bin/ignite3-db start + $IGNITE_HOME/bin/ignite3-db ``` 3. (optional) Setup ignite3-cli in your terminal: ``` - cd ignite3-cli-3.0.0-beta1 - alias ignite3="$(pwd)/bin/ignite3" >> ~/.bash_profile + alias ignite3="${ignite-3-cli folder}/bin/ignite3" >> ~/.bash_profile source bin/ignite_completion.sh ``` 4. (optional) If the cluster is not initialized then initialize the cluster: ``` - ignite3 cluster init --name=ignite-cluster --url=http://localhost:10300 --meta-storage-node=defauldNode + ignite3 cluster init --name=ignite-cluster --url=http://localhost:10300 --metastorage-group=defaultNode ``` 5. Run the preferred example in the IDE.