Skip to content

Commit

Permalink
move docs url
Browse files Browse the repository at this point in the history
  • Loading branch information
simerplaha committed Sep 23, 2023
1 parent dd20d6d commit f420244
Show file tree
Hide file tree
Showing 29 changed files with 42 additions and 42 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ latest (unstable).

**Status**: Under testing & performance optimisations. See [project status](#Project-status).

[Documentation](http://swaydb.io)
[Documentation](https://swaydb.simer.au)

# Sponsors

Expand All @@ -44,19 +44,19 @@ for full-featured open-source licences to their awesome development tools!
## Overview

- Simple data types - `Map`, `Set`, `Queue`, `SetMap` & `MultiMap` with native Java and Scala collections support.
- Conditional updates using any pure [JVM function](http://swaydb.io/api/pure-functions/?language=java) - **No query
- Conditional updates using any pure [JVM function](https://swaydb.simer.au/api/pure-functions/?language=java) - **No query
language**.
- Atomic updates and inserts with `Transaction` API.
- **Non-blocking core** with configurable APIs for blocking, non-blocking and/or reactive use-cases.
- Single or multiple disks persistent, in-memory or eventually persistent.
- [Streams](http://swaydb.io/api/stream/?language=java) - Async & sync forward and reverse data streaming/iteration.
- TTL - non-blocking, non-polling asynchronous auto [expiring](http://swaydb.io/api/expire/?language=java) key-values.
- [Streams](https://swaydb.simer.au/api/stream/?language=java) - Async & sync forward and reverse data streaming/iteration.
- TTL - non-blocking, non-polling asynchronous auto [expiring](https://swaydb.simer.au/api/expire/?language=java) key-values.
- Range operations to update, remove & expire a range of key-values.
- Key only iterations (Lazily fetched values).
- [Configurable compression](http://swaydb.io/configuration/compressions/?language=scala) with LZ4 & Snappy
- [Configurable compression](https://swaydb.simer.au/configuration/compressions/?language=scala) with LZ4 & Snappy
- Configurable core internals to support custom workloads.
- Duplicate values elimination
with [compressDuplicateValues](http://swaydb.io/configuration/valuesConfig/?language=scala).
with [compressDuplicateValues](https://swaydb.simer.au/configuration/valuesConfig/?language=scala).

## Use cases

Expand All @@ -71,8 +71,8 @@ Highly configurable to suit **different workloads**. Some known use-cases are:

## Quick start

- [Java - Quick start](http://swaydb.io/quick-start/?language=java&data-type=map&functions=off)
- [Scala - Quick start](http://swaydb.io/quick-start/?language=scala&data-type=map&functions=off)
- [Java - Quick start](https://swaydb.simer.au/quick-start/?language=java&data-type=map&functions=off)
- [Scala - Quick start](https://swaydb.simer.au/quick-start/?language=scala&data-type=map&functions=off)
- [Kotlin - Quick start](https://github.com/simerplaha/SwayDB.kotlin.examples/blob/master/src/main/kotlin/quickstart/QuickStartMapSimple.kt)

## Contributing
Expand Down
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ val publishSettings = Seq[Setting[_]](
publishLocal := {},
sonatypeProjectHosting := Some(GitHubHosting("simerplaha", "SwayDB", "[email protected]")),
developers := List(
Developer(id = "simerplaha", name = "Simer JS Plaha", email = "[email protected]", url = url("http://swaydb.io"))
Developer(id = "simerplaha", name = "Simer JS Plaha", email = "[email protected]", url = url("https://swaydb.simer.au"))
),
scalacOptions ++= scalaOptions,
publishTo := sonatypePublishTo.value,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ import scala.jdk.CollectionConverters._
sealed trait PersistentConfig

/**
* http://swaydb.io#configuring-levels
* https://swaydb.simer.au#configuring-levels
*/
object ConfigWizard {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ object Accelerator {
)

/**
* http://swaydb.io/configuring-levels/acceleration
* https://swaydb.simer.au/configuring-levels/acceleration
*/
private def nextLogSize(mapCount: Int,
increaseLogSizeBy: Int,
Expand All @@ -47,7 +47,7 @@ object Accelerator {
(level0Meter.currentLogSize * increaseLogSizeBy) min maxLogSize

/**
* http://swaydb.io/configuring-levels/acceleration/brake
* https://swaydb.simer.au/configuring-levels/acceleration/brake
*/
def brake(increaseLogSizeOnMapCount: Int = 4,
increaseLogSizeBy: Int = 2,
Expand Down Expand Up @@ -79,7 +79,7 @@ object Accelerator {
NoBrakesBuilder.builder()

/**
* http://swaydb.io/configuring-levels/acceleration/noBrakes
* https://swaydb.simer.au/configuring-levels/acceleration/noBrakes
*/

def noBrakes(onMapCount: Int = 6,
Expand All @@ -105,7 +105,7 @@ object Accelerator {
}

/**
* http://swaydb.io/configuring-levels/acceleration
* https://swaydb.simer.au/configuring-levels/acceleration
*/
case class Accelerator(nextLogSize: Int,
brake: Option[Brake])
8 changes: 4 additions & 4 deletions core/src/main/scala/swaydb/core/CoreInitializer.scala
Original file line number Diff line number Diff line change
Expand Up @@ -75,16 +75,16 @@ private[core] object CoreInitializer extends LazyLogging {
}

/**
* Initialises Core/Levels. To see full documentation for each input parameter see the website - http://swaydb.io/configurations/.
* Initialises Core/Levels. To see full documentation for each input parameter see the website - https://swaydb.simer.au/configurations/.
*
* @param config configuration used for initialisations which is created via [[ConfigWizard]]
* @param enableTimer if true initialises the timer folder. This is only required if the database has functions enabled.
* @param cacheKeyValueIds if true, will cache the 3000+ key-values in-memory instead of performing binary search for each search key-value id.
* Set this to true to boost performance and reduce IOps.
* @param fileCache Controls when files are closed & deleted. See the configuration documentation - http://swaydb.io/configurations/fileCache/
* @param fileCache Controls when files are closed & deleted. See the configuration documentation - https://swaydb.simer.au/configurations/fileCache/
* @param threadStateCache Each thread is assigned a small cache to boost read performance. This can be optionally enabled. See
* http://swaydb.io/configurations/threadStateCache/
* @param memoryCache Configures how in-memory caches should process read bytes and parsed key-values. See - http://swaydb.io/configurations/memoryCache/
* https://swaydb.simer.au/configurations/threadStateCache/
* @param memoryCache Configures how in-memory caches should process read bytes and parsed key-values. See - https://swaydb.simer.au/configurations/memoryCache/
* @param keyOrder Defines the sort order for keys. See documentation on website.
* @param timeOrder Defines the order in which a single key-value's updates are applied.
* @param functionStore Stores all registered functions.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ class LevelZeroTaskAssigner_flatten_Spec extends TestBase with MockFactory {
//where flattening merge (concurrent) resulted in a deadline to expire a key-value immediately
//and sequential merge resulted in allowing the key-value's deadline to be extended or vice-versa.
//This happens when the order of merge is not the same and only effects key-values with deadline.
//Documentation - http://swaydb.io/implementation/compaction/increasing-expiration-time/?language=java
//Documentation - https://swaydb.simer.au/implementation/compaction/increasing-expiration-time/?language=java
val expectedMerged = merge(expected, Slice.empty, true)
val actualMerged = merge(actual, Slice.empty, true)
actualMerged shouldBe expectedMerged
Expand Down
2 changes: 1 addition & 1 deletion effect/src/main/scala/swaydb/Exception.scala
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ object Exception {
*
* @param functionId the id of the missing function.
*/
case class FunctionNotFound(functionId: String) extends Exception(s"Function with id '$functionId' not found. Make sure the function is added to the instance. See documentation http://swaydb.io/.")
case class FunctionNotFound(functionId: String) extends Exception(s"Function with id '$functionId' not found. Make sure the function is added to the instance. See documentation https://swaydb.simer.au/.")
case class OverlappingFileLock(exception: OverlappingFileLockException) extends Exception("Failed to get directory lock.")
case class FailedToWriteAllBytes(written: Int, expected: Int, bytesSize: Int) extends Exception(s"Failed to write all bytes written: $written, expected : $expected, bytesSize: $bytesSize")
case class CannotCopyInMemoryFiles(file: Path) extends Exception(s"Cannot copy in-memory files $file")
Expand Down
2 changes: 1 addition & 1 deletion project/build.properties
Original file line number Diff line number Diff line change
@@ -1 +1 @@
sbt.version=1.5.5
sbt.version=1.8.2
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import java.nio.charset.StandardCharsets
/**
* Default serializers.
*
* Documentation for custom serializers: http://www.swaydb.io/custom-serializers
* Documentation for custom serializers: https://swaydb.simer.au/custom-serializers
*/
object Default {

Expand Down
2 changes: 1 addition & 1 deletion slice/src/main/scala/swaydb/slice/Slice.scala
Original file line number Diff line number Diff line change
Expand Up @@ -1152,7 +1152,7 @@ object Slices {
* provide similar functionality as [[Slice]].
*
* This type is mainly used by BlockCache which stores byte arrays
* in the configured block-size via <a href="https://swaydb.io/configuration/memoryCache/?language=java">minIOSeekSize</a>.
* in the configured block-size via <a href="https://swaydb.simer.au/configuration/memoryCache/?language=java">minIOSeekSize</a>.
*
* When a read is submitted to BlockCache which is greater than the configured `minIOSeekSize`
* we do not want to copy byte arrays to form a single [[Slice]] but use [[Slices]] which can
Expand Down
2 changes: 1 addition & 1 deletion slice/src/main/scala/swaydb/slice/SliceReader.scala
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import java.nio.file.Paths
import scala.reflect.ClassTag

/**
* http://www.swaydb.io/slice/byte-slice
* https://swaydb.simer.au/slice/byte-slice
*/
case class SliceReader[@specialized(Byte) B](slice: Slice[B],
private var position: Int = 0)(implicit val byteOps: ByteOps[B]) extends Reader[B] {
Expand Down
2 changes: 1 addition & 1 deletion slice/src/main/scala/swaydb/slice/order/KeyOrder.scala
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ object KeyOrder {
* Default ordering.
*
* Custom key-ordering can be implemented.
* Documentation: http://www.swaydb.io/custom-key-ordering
* Documentation: https://swaydb.simer.au/custom-key-ordering
*
*/
val default, lexicographic: KeyOrder[Slice[Byte]] =
Expand Down
2 changes: 1 addition & 1 deletion swaydb-java/src/main/scala/swaydb/java/Map.scala
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ import scala.concurrent.duration
import scala.jdk.CollectionConverters._

/**
* Documentation - http://swaydb.io/
* Documentation - https://swaydb.simer.au/
*/
case class Map[K, V, F](asScala: swaydb.Map[K, V, F, Glass])(implicit evd: F <:< PureFunction.Map[K, V]) extends swaydb.java.MapT[K, V, F] {

Expand Down
2 changes: 1 addition & 1 deletion swaydb-java/src/main/scala/swaydb/java/MultiMap.scala
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ import scala.concurrent.duration
import scala.jdk.CollectionConverters._

/**
* Documentation - http://swaydb.io/
* Documentation - https://swaydb.simer.au/
*/
case class MultiMap[M, K, V, F](asScala: swaydb.MultiMap[M, K, V, F, Glass])(implicit evd: F <:< PureFunction.Map[K, V]) extends MapT[K, V, F] {

Expand Down
2 changes: 1 addition & 1 deletion swaydb-java/src/main/scala/swaydb/java/Set.scala
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import scala.compat.java8.DurationConverters._
import scala.jdk.CollectionConverters._

/**
* Documentation - http://swaydb.io/
* Documentation - https://swaydb.simer.au/
*/
case class Set[A, F](asScala: swaydb.Set[A, F, Glass])(implicit evd: F <:< PureFunction[A, Nothing, Apply.Set[Nothing]]) extends Source[A, A] {

Expand Down
2 changes: 1 addition & 1 deletion swaydb-java/src/main/scala/swaydb/java/SetMap.scala
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ import scala.compat.java8.DurationConverters._
import scala.jdk.CollectionConverters._

/**
* Documentation - http://swaydb.io/
* Documentation - https://swaydb.simer.au/
*/
case class SetMap[K, V](asScala: swaydb.SetMap[K, V, Glass]) extends SetMapT[K, V] {

Expand Down
2 changes: 1 addition & 1 deletion swaydb/src/main/scala/swaydb/Map.scala
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import scala.concurrent.duration.{Deadline, FiniteDuration}
/**
* Map database API.
*
* For documentation check - http://swaydb.io/
* For documentation check - https://swaydb.simer.au/
*/
case class Map[K, V, F, BAG[_]] private(private val core: Core[BAG])(implicit val keySerializer: Serializer[K],
val valueSerializer: Serializer[V],
Expand Down
2 changes: 1 addition & 1 deletion swaydb/src/main/scala/swaydb/Set.scala
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ import scala.concurrent.duration.{Deadline, FiniteDuration}
/**
* Set database API.
*
* For documentation check - http://swaydb.io/
* For documentation check - https://swaydb.simer.au/
*/
case class Set[A, F, BAG[_]] private(private val core: Core[BAG])(implicit serializer: Serializer[A],
bag: Bag[BAG]) extends Source[A, A, BAG] { self =>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ object Map extends LazyLogging {
/**
* A 3 Leveled in-memory database where the 3rd is persistent.
*
* For custom configurations read documentation on website: http://www.swaydb.io/configuring-levels
* For custom configurations read documentation on website: https://swaydb.simer.au/configuring-levels
*/
def apply[K, V, F <: PureFunction.Map[K, V], BAG[_]](dir: Path,
logSize: Int = DefaultConfigs.logSize,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ object MultiMap extends LazyLogging {
/**
* A 3 Leveled in-memory database where the 3rd is persistent.
*
* For custom configurations read documentation on website: http://www.swaydb.io/configuring-levels
* For custom configurations read documentation on website: https://swaydb.simer.au/configuring-levels
*/
def apply[M, K, V, F <: PureFunction.Map[K, V], BAG[_]](dir: Path,
logSize: Int = DefaultConfigs.logSize,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ import scala.concurrent.duration.FiniteDuration
object Queue extends LazyLogging {

/**
* For custom configurations read documentation on website: http://www.swaydb.io/configuring-levels
* For custom configurations read documentation on website: https://swaydb.simer.au/configuring-levels
*
*
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ import scala.reflect.ClassTag
object Set extends LazyLogging {

/**
* For custom configurations read documentation on website: http://www.swaydb.io/configuring-levels
* For custom configurations read documentation on website: https://swaydb.simer.au/configuring-levels
*/
def apply[A, F <: PureFunction.Set[A], BAG[_]](dir: Path,
logSize: Int = DefaultConfigs.logSize,
Expand Down
2 changes: 1 addition & 1 deletion swaydb/src/main/scala/swaydb/memory/Queue.scala
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ import scala.concurrent.duration.FiniteDuration
object Queue extends LazyLogging {

/**
* For custom configurations read documentation on website: http://www.swaydb.io/configuring-levels
* For custom configurations read documentation on website: https://swaydb.simer.au/configuring-levels
*/
def apply[A, BAG[_]](logSize: Int = DefaultConfigs.logSize,
minSegmentSize: Int = DefaultConfigs.segmentSize,
Expand Down
2 changes: 1 addition & 1 deletion swaydb/src/main/scala/swaydb/memory/Set.scala
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ import scala.reflect.ClassTag
object Set extends LazyLogging {

/**
* For custom configurations read documentation on website: http://www.swaydb.io/configuring-levels
* For custom configurations read documentation on website: https://swaydb.simer.au/configuring-levels
*/
def apply[A, F <: PureFunction.Set[A], BAG[_]](logSize: Int = DefaultConfigs.logSize,
minSegmentSize: Int = DefaultConfigs.segmentSize,
Expand Down
2 changes: 1 addition & 1 deletion swaydb/src/main/scala/swaydb/memory/SetMap.scala
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import scala.reflect.ClassTag
object SetMap extends LazyLogging {

/**
* For custom configurations read documentation on website: http://www.swaydb.io/configuring-levels
* For custom configurations read documentation on website: https://swaydb.simer.au/configuring-levels
*/
def apply[K, V, BAG[_]](logSize: Int = DefaultConfigs.logSize,
minSegmentSize: Int = DefaultConfigs.segmentSize,
Expand Down
2 changes: 1 addition & 1 deletion swaydb/src/main/scala/swaydb/multimap/MultiKey.scala
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ private[swaydb] object MultiKey {

/**
* Implements un-typed ordering for performance. This ordering can also be implemented using types.
* See documentation at http://www.swaydb.io/custom-key-ordering/
* See documentation at https://swaydb.simer.au/custom-key-ordering/
*
* Creates dual ordering on [[MultiKey.childId]]. Orders mapKey using the [[KeyOrder.default]] order
* and applies custom ordering on the user provided keys.
Expand Down
2 changes: 1 addition & 1 deletion swaydb/src/main/scala/swaydb/persistent/Queue.scala
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ import java.nio.file.Path
object Queue extends LazyLogging {

/**
* For custom configurations read documentation on website: http://www.swaydb.io/configuring-levels
* For custom configurations read documentation on website: https://swaydb.simer.au/configuring-levels
*/
def apply[A, BAG[_]](dir: Path,
logSize: Int = DefaultConfigs.logSize,
Expand Down
2 changes: 1 addition & 1 deletion swaydb/src/main/scala/swaydb/persistent/Set.scala
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ import scala.reflect.ClassTag
object Set extends LazyLogging {

/**
* For custom configurations read documentation on website: http://www.swaydb.io/configuring-levels
* For custom configurations read documentation on website: https://swaydb.simer.au/configuring-levels
*/
def apply[A, F <: PureFunction.Set[A], BAG[_]](dir: Path,
logSize: Int = DefaultConfigs.logSize,
Expand Down
2 changes: 1 addition & 1 deletion tools/src/main/scala/swaydb/tools/RepairAppendix.scala
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import java.nio.file.Path
object RepairAppendix {

/**
* Documentation: http://www.swaydb.io/api/repairAppendix
* Documentation: https://swaydb.simer.au/api/repairAppendix
*/
def apply[K](levelPath: Path,
repairStrategy: AppendixRepairStrategy)(implicit serializer: Serializer[K],
Expand Down

0 comments on commit f420244

Please sign in to comment.