Skip to content

Commit

Permalink
Corrected underline in all files and added html comment for proofread…
Browse files Browse the repository at this point in the history
…ing tracking
  • Loading branch information
smolinari committed Nov 27, 2015
1 parent 334f966 commit 57a590f
Show file tree
Hide file tree
Showing 32 changed files with 41 additions and 26 deletions.
1 change: 1 addition & 0 deletions Chat-use-case.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- proofread 2015-11-26 SAM -->
# Chat Use Case

OrientDB allows modeling of rich and complex domains. If you want to develop a chat based application, you can use whatever you want to create the relationships between User and Room.
Expand Down
1 change: 1 addition & 0 deletions Choosing-between-Graph-or-Document-API.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- proofread 2015-11-26 SAM -->
# Graph or Document API?

In OrientDB, we created 2 different APIs: the Document API and the Graph API. The Graph API works on top of the Document API. The Document API contains the Document, Key/Value and Object Oriented models. The Graph API handles the Vertex and Edge relationships.
Expand Down
1 change: 1 addition & 0 deletions Cluster-Selection.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- proofread 2015-11-26 SAM -->
# Cluster Selection

When you create a new record and specify the [class](Concepts.md#class) to which it belongs, OrientDB automatically selects a [cluster](Concepts.md#cluster), where it stores the physical data of the record. There are a number of configuration strategies available for you to use in determining how OrientDB selects the appropriate cluster for the new record.
Expand Down
1 change: 1 addition & 0 deletions Concepts.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- proofread 2015-11-26 SAM -->
# Basic Concepts


Expand Down
1 change: 1 addition & 0 deletions Concurrency.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- proofread 2015-11-26 SAM -->
# Concurrency

OrientDB uses an optimistic approach to concurrency. Optimistic Concurrency Control, or [OCC](http://en.wikipedia.org/wiki/Optimistic_concurrency_control) assumes that multiple transactions can compete frequently without interfering with each other.
Expand Down
2 changes: 1 addition & 1 deletion Docker-Home.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- proofread 2015-11-26 SAM -->
#Installing in a Docker Container
_____

[OrientDB](http://www.orientdb.org) is the first Multi-Model Open Source NoSQL DBMS that combines the power of graphs and the flexibility of documents into one scalable, high-performance operational database.

Expand Down
2 changes: 1 addition & 1 deletion Fetching-Strategies.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- proofread 2015-11-26 SAM -->
# Fetching Strategies
____

*Fetchplans* are used in two different scopes:

Expand Down
3 changes: 2 additions & 1 deletion Inheritance.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<!-- proofread 2015-11-26 SAM -->

# Inheritance
____

Unlike many Object-relational mapping tools, OrientDB does not split documents between different classes. Each document resides in one or a number of clusters associated with its specific class. When you execute a query against a class that has subclasses, OrientDB searches the clusters of the target class and all subclasses.

Expand Down
2 changes: 1 addition & 1 deletion Key-Value-use-case.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- proofread 2015-11-26 SAM -->
# Key Value Use Case
____

OrientDB can also be used as a Key Value DBMS by using the super fast [Indexes](Indexes.md). You can have as many [Indexes](Indexes.md) as you need.

Expand Down
1 change: 1 addition & 0 deletions Managing-Dates.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- proofread 2015-11-26 SAM -->
# Managing Dates

OrientDB treats dates as first class citizens. Internally, it saves dates in the [Unix time](https://en.wikipedia.org/wiki/Unix_time) format. Meaning, it stores dates as a `long` variable, which contains the count in milliseconds since the Unix Epoch, (that is, 1 January 1970).
Expand Down
2 changes: 1 addition & 1 deletion Queue-use-case.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- proofread 2015-11-26 SAM -->
# Distributed queues use case
____

Implementing a persistent, distributed and transactional queue system using OrientDB is possible and easy. Besides the fact you don't need a specific API accomplish a queue, there are multiple approaches you can follow depending by your needs. The easiest way is using OrientDB SQL, so this works wit any driver.

Expand Down
2 changes: 1 addition & 1 deletion SQL-Delete.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- proofread 2015-11-26 SAM -->
# SQL - DELETE
____

The **Delete** command deletes one or more records from the database. The set of records involved are taken by the [WHERE](SQL-Where.md) clause.

Expand Down
2 changes: 1 addition & 1 deletion SQL-Insert.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- proofread 2015-11-26 SAM -->
# SQL - INSERT
____

The **Insert** command creates a new record in the database. Records can be schema-less or conform to rules you specify in your model.

Expand Down
2 changes: 1 addition & 1 deletion SQL-Query.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- proofread 2015-11-26 SAM -->
# SQL - SELECT
____

Orient supports the SQL language to execute queries against the database engine. Take a look at the [operators](SQL-Where.md#operators) and [Functions](SQL-Where.md#functions). To learn the main differences in comparison to the SQL-92 standard, take a look at: [OrientDB SQL](SQL.md).

Expand Down
2 changes: 1 addition & 1 deletion SQL-Update.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- proofread 2015-11-26 SAM -->
# SQL - UPDATE
____

Update one or more records in the current database. Remember that OrientDB can work also in schema-less mode, so you can create any field on-the-fly. Furthermore, OrientDB works on collections. This is the reason why OrientDB SQL has some extensions to handle collections.

Expand Down
2 changes: 1 addition & 1 deletion Schema.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- proofread 2015-11-26 SAM -->
# Schema
____

While OrientDb can work in a schema-less mode, you may find it necessary at times to enforce a schema on your data model. OrientDB supports both schema-full and schema-hybrid solutions.

Expand Down
2 changes: 1 addition & 1 deletion Time-series-use-case.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- proofread 2015-11-26 SAM -->
# Time Series Use Case
____

Managing records related to historical information is pretty common. When you have millions of records, indexes start show their limitations, because the cost to find the records is O(logN). This is also the main reason why Relational DBMS are so slow with huge databases.

Expand Down
3 changes: 2 additions & 1 deletion Tutorial-Classes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<!-- proofread 2015-11-26 SAM -->
# Classes
____


Multi-model support in the OrientDB engine provides a number of ways in approaching and understanding its basic concepts. These concepts are clearest when viewed from the perspective of the Document Database API. Like many database management systems, OrientDB uses the [Record](Concepts.md#record) as an element of storage. There are many types of records, but with the Document Database API, records always use the [Document](Concepts.md#document) type. Documents are formed by a set of key/value pairs, referred to as fields and properties, and can belong to a class.

Expand Down
3 changes: 2 additions & 1 deletion Tutorial-Clusters.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<!-- proofread 2015-11-26 SAM -->
# Clusters
____


The [Cluster](Concepts.md#cluster) is a place where a group of records are stored. Like the [Class](Concepts.md#class), it is comparable with the collection in traditional document databases, and in relational databases with the table. However, this is a loose comparison given that unlike a table, clusters allow you to store the data of a class in different physical locations.

Expand Down
2 changes: 1 addition & 1 deletion Tutorial-Document-and-graph-model.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- proofread 2015-11-26 SAM -->
# Multi-Model
____

The OrientDB engine supports **Graph**, **Document**, **Key/Value**, and **Object** models, so you can use OrientDB as a replacement for a product in any of these categories. However, the main reason why users choose OrientDB is because of its true **Multi-Model** DBMS abilities, which combine all the features of the four models into the core. These abilities are not just interfaces to the database engine, but rather the engine itself was built to support all four models. This is also the main difference to other multi-model DBMSs, as they implement an additional layer with an API, which mimics additional models. However, under the hood, they're truly only one model, therefore they are limited in speed and scalability.

Expand Down
2 changes: 1 addition & 1 deletion Tutorial-Installation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- proofread 2015-11-26 SAM -->
# Installation
____

OrientDB is available in two editions:

Expand Down
3 changes: 2 additions & 1 deletion Tutorial-Introduction-to-the-NoSQL-world.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<!-- proofread 2015-11-26 SAM -->

# Getting Started
____

Over the past few years, there has been an explosion of many NoSQL database solutions and products. The meaning of the word "NoSQL" is not a campaign against the SQL language. In fact, OrientDB allows for SQL syntax! NoSQL is probably best described by the following:

Expand Down
3 changes: 2 additions & 1 deletion Tutorial-Record-ID.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<!-- proofread 2015-11-26 SAM -->
# Record ID
____


In OrientDB, each record has its own self-assigned unique ID within the database called [Record ID](Concepts.md#wiki-RecordID) or RID. It is composed of two parts:

Expand Down
2 changes: 1 addition & 1 deletion Tutorial-Relationships.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- proofread 2015-11-26 SAM -->
# Relationships
____

One of the most important features of Graph databases lies in how they manage relationships. Many users come to OrientDB from MongoDB due to OrientDB having more efficient support for relationships.

Expand Down
2 changes: 1 addition & 1 deletion Tutorial-Run-the-console.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- proofread 2015-11-26 SAM -->
# Running the OrientDB Console
____

There are various methods you can use to connect to your database server and the individual databases, once the server is running, such as the [Network Binary](Network-Binary-Protocol.md) and [HTTP/REST](OrientDB-REST.d) protocols. In addition to these, OrientDB provides a command-line interface for connecting to and working with the database server.

Expand Down
2 changes: 1 addition & 1 deletion Tutorial-Run-the-server.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- proofread 2015-11-26 SAM -->
# Running the OrientDB Server
____

When you finish installing OrientDB, whether you build it from source or download the binary package, you are ready to launch the database server. You can either start it through the system daemon or through the provided server script. This article only covers the latter.

Expand Down
3 changes: 2 additions & 1 deletion Tutorial-Using-schema-with-graphs.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<!-- proofread 2015-11-26 SAM -->
# Using Schema with Graphs
____


OrientDB, through the Graph API, offers a number of features above and beyond the traditional Graph Databases given that it supports concepts drawn from both the Document Database and the Object Oriented worlds. For instance, consider the power of graphs, when used in conjunction with schemas and constraints.

Expand Down
3 changes: 2 additions & 1 deletion Tutorial-Working-with-graphs.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<!-- proofread 2015-11-26 SAM -->
# Working with Graphs
____


In graph databases, the database system graphs data into network-like structures consisting of vertices and edges. In the OrientDB [Graph model](Tutorial-Document-and-graph-model.md#graph-model), the database represents data through the concept of a property graph, which defines a vertex as an entity linked with other vertices and an edge, as an entity that links two vertices.

Expand Down
2 changes: 1 addition & 1 deletion Types.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- proofread 2015-11-26 SAM -->
# Supported Types
____

OrientDB supports several types natively. Below is the complete table.

Expand Down
3 changes: 2 additions & 1 deletion Unix-Service.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<!-- proofread 2015-11-26 SAM -->

# Install as Service on Unix/Linux
____

OrientDB ships with a script, which will allow you to run the database server as a daemon. You can find it in the `bin/` directory of your installation, (that is, at `$ORIENTDB_HOME/bin/orientdb.sh`.

Expand Down
2 changes: 1 addition & 1 deletion Use-Cases.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- proofread 2015-11-26 SAM -->
# Use Cases
____

This page contains the solution to the most common use cases. Please don't consider them as the definitive solution, but as suggestions where to get the idea to solve your needs.

Expand Down
3 changes: 2 additions & 1 deletion Windows-Service.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<!-- proofread 2015-11-26 SAM -->

# Install as a Service on Windows
____

OrientDB is a Java server application. As most server applications, they have to perform several tasks, before being able to shut down the Virtual Machine process, hence they need a portable way to be notified of the imminent Virtual Machine shutdown.
At the moment, the only way to properly shut down an OrientDB server instance (not embedded) is to execute the *shutdown.bat* (or *shutdown.sh*) script shipped with the OrientDB distribution, but it's up to the user to take care of this. This implies that the server instance isn't stopped correctly, when the computer on which it is deployed, is shut down without executing the above script.
Expand Down

0 comments on commit 57a590f

Please sign in to comment.