update readme

Author: Vladimir Ershov

README.md

@@ -1,18 +1,18 @@
 # pgpro_scheduler - расширение PostgreSQL для управления расписанием задач
 
 pgpro_scheduler это планировщик задач для СУБД PostgreSQL, который позволяет
-планировать исполнение задач в базе и контроллировать их исполнение.
+планировать выполнение задач в базе и контроллировать их исполнение.
 
 Задачи это наборы SQL команд. Расписание выполнения задач задается либо строкой
 cron, либо указанием конкретных дат запуска, либо JSON объектом, в котором
 указывается в какие дни часы и минуты задача должна быть запущена. Возможна
 комбинация методов описания расписания.
 
 Каждая задача имеет возможность для вычисления времени следующего своего
-запуска. Набор SQL команд в задаче может обрабатываться в разных транзакциях, 
-по транзакции на команду, или в одной. В последнем случае имеется возможность 
-задания SQL конманды, которая будет выполняться в случае аварийного завершения 
-транзакции.
+запуска. Набор SQL команд в задаче может обрабатываться в одной транзакции или
+же каждая команда может использовать свою индивидуальную транзакцию.
+Имеется возможность задания SQL команды, которая будет выполняться в случае
+аварийного завершения транзакции.
 
 ## Installation
 
@@ -36,10 +36,11 @@ pgpro_scheduler это расширение PostgreSQL и не тербует н
 Расширение определяет ряд переменных в PostgreSQL (GUC), которые позволяют 
 управлять его конфигурацией.
 
-*	**schedule.enable** - двоичная переменная, которая поределяет разрешено ли 
+*	**schedule.enable** - двоичная переменная, которая определяет разрешено ли 
 	выполнение расширения. По умолчанию: false. 
 * 	**schedule.database** - строковая переменная, указывает с какими базам может
-	работать расширение. По умолчанию - пустая строка.
+	работать планировщик. Что бы указать несколько баз, нужно перечислить их
+	имена через запятую. По умолчанию - пустая строка.
 *	**schedule.nodename** - строковая переменная, содержит название узла.
 	По умолчанию - master. Если расширение используется на одной машине,
 	то переменная не имеет смысла.
@@ -81,7 +82,7 @@ PostgreSQL, которые описаны в предыдущем разделе
 	# SELECT pg_reload_conf();
 
 Если вам не нужны указания различных значений для разных баз данных, то все это 
-можно занести в конфигурационный файл PostgreSQL и перечитать конфигурацию.
+можно занести в конфигурационный файл PostgreSQL, и перечитать конфигурацию.
 Перезапуска не требуется.
 
 Пример записей в `$DATADIR/postgresql.conf`, если количество одновременно 
@@ -121,23 +122,26 @@ PostgreSQL, которые описаны в предыдущем разделе
 Планировщик определяет 2 SQL типа, которые он использует в качестве типов 
 возвращаемых значений для своих функций.
 
-**cron_rec** - используется для информации о записи задачи в таблице расписания.
+### cron_rec
+
+Тип используется для информации о задаче в таблице расписания.
 
 	CREATE TYPE schedule.cron_rec AS(
 		id integer,             -- идентификатор задачи
 		node text,              -- имя узла, на котором она будет выполняться
 		name text,              -- имя задачи
 		comments text,          -- комментарий к задаче
 		rule jsonb,             -- правила построения расписания
-		commands text[],        -- sql комманды, которые будут выполненны
+		commands text[],        -- sql команды, которые будут выполнены
 		run_as text,            -- имя пользователя, с которым будет выполняться
 								-- задача
 		owner text,             -- имя пользователя, который создал задачу
 		start_date timestamp,   -- нижняя граница временного периода, во время
-								-- которого допускается выполнение задачи
-								-- граница считаеися открытой если значение NULL
+								-- которого допускается выполнение задачи,
+								-- граница считается открытой, если значение NULL
 		end_date timestamp,     -- верхняя граница временного периода, во время
-								-- граница считаеися открытой если значение NULL
+								-- которого допускается выполнение задачи,
+								-- граница считается открытой, если значение NULL
 		use_same_transaction boolean,   -- если true, то набор команд будет 
 										-- выполняться в одной транзакции
 		last_start_available interval,  -- максимальное время, на которое может 
@@ -149,7 +153,7 @@ PostgreSQL, которые описаны в предыдущем разделе
 		max_run_time interval,  -- максимальное время выполнения задачи
 		onrollback text,        -- SQL команда, которая будет выполнена в случае
 								-- аварийного завершения транзакции
-		next_time_statement text,   -- SQL команда, которая будет выполненна 
+		next_time_statement text,   -- SQL команда, которая будет выполнена 
 									-- после завершения основного набора SQL 
 									-- команд, которая возвращает следующее
 									-- время выполнения задачи
@@ -159,22 +163,25 @@ PostgreSQL, которые описаны в предыдущем разделе
 								-- которые не позволяют ее выполнять далее
 	);
 
-**cron_job** используется для информации о конкретном исполнении задачи.
+###cron_job
+
+Тип используется для информации о конкретном исполнении задачи.
 
 	CREATE TYPE schedule.cron_job AS(
 		cron integer,           -- идентификатор задачи
 		node text,              -- имя узла, на котором она выполняться
 		scheduled_at timestamp, -- запланированное время выполнения
 		name text,              -- имя задачи
 		comments text,          -- комментарий к задаче
-		commands text[],        -- sql комманды для выполнения
-		run_as text,            -- имя пользователя, из-под которого идет выполнение
+		commands text[],        -- sql команды для выполнения
+		run_as text,            -- имя пользователя, с правами которого будет
+								-- выполнен набор команд
 		owner text,             -- имя пользователя, создавшего задачу
 		use_same_transaction boolean,	-- если true, то набор команд 
 								-- выполняется в одной транзакции
 		started timestamp,      -- время, когда задача была запущена
 		last_start_available timestamp,	-- время, до которого задача должна
-								-- быть запцщена
+								-- быть запущена
 		finished timestamp,     -- время, когда задача была завершена
 		max_run_time interval,  -- время, за которое задача должна выполнится,
 								-- иначе она будет аварийно остановлена
@@ -209,7 +216,7 @@ PostgreSQL, которые описаны в предыдущем разделе
 Агрументы:
 
 * **cron** - crontab-like строка для задания расписания выполнения
-* **sqls** - набор SQL комманд для выполнения в виде массива строк
+* **sqls** - набор SQL команд для выполнения в виде массива строк
 * **node** - название узла, опционально
 
 Возвращает идентификатор созданной задачи.
@@ -233,7 +240,7 @@ PostgreSQL, которые описаны в предыдущем разделе
 Агрументы:
 
 * **date** - время исполнения задачи
-* **sqls** - набор SQL комманд для выполнения в виде массива строк
+* **sqls** - набор SQL команд для выполнения в виде массива строк
 * **node** - название узла, опционально
 
 Возвращает идентификатор созданной задачи.
@@ -244,7 +251,7 @@ PostgreSQL, которые описаны в предыдущем разделе
 
 Агрументы:
 
-* **dates** - набор дат для выполнения комманды в виде массива
+* **dates** - набор дат для выполнения команды в виде массива
 * **sql** - строка, SQL команда для выполнения
 * **node** - название узла, опционально
 
@@ -256,8 +263,8 @@ PostgreSQL, которые описаны в предыдущем разделе
 
 Агрументы:
 
-* **dates** - набор дат для выполнения комманды в виде массива
-* **sqls** - набор SQL комманд для выполнения в виде массива строк
+* **dates** - набор дат для выполнения команды в виде массива
+* **sqls** - набор SQL команд для выполнения в виде массива строк
 * **node** - название узла, опционально
 
 Возвращает идентификатор созданной задачи.
@@ -269,7 +276,7 @@ PostgreSQL, которые описаны в предыдущем разделе
 Единтвенный принимаемый параметр является объектом JSONB, который содержит
 информацию о создаваемой задаче.
 
-JSONB объект может содержат следующие ключи, не все они являются обязательными:
+JSONB объект может содержать следующие ключи, не все они являются обязательными:
 
 *	**name** - имя задачи;
 *	**node** - имя узла, на котором будет выполняться задача;
@@ -278,15 +285,15 @@ JSONB объект может содержат следующие ключи, н
 *	**rule** - расписание в виде JSONB объекта (смотри далее);
 *	**command** - SQL команда для выполнения;
 *	**commands** - набор SQL команд для выполнения в виде массива;
-*	**run\_as** - пользователь, с правами которого будет исполняться задача
+*	**run\_as** - пользователь, с правами которого будет выполняться задача
 *	**start\_date** - начало временного периода, во время которого возможен 
 	запуск выполнения задачи, если не указано, то нижняя граница не определена;
 *	**end\_date** - окончание временного периода, во время которого возможен
 	запуск выполнения задачи, если не указано, то верхняя граница не определена;
 *	**date** - конкретная дата запуска задачи;
-*	**dates** - надор дат запуска задачи;
+*	**dates** - набор дат запуска задачи;
 *	**use\_same\_transaction** - устанавливает будет ли набор команд выполняться
-	в рамках одной транзакции. По умолчанию: true TODO ???
+	в рамках одной транзакции. По умолчанию: false; 
 *	**last\_start\_available** - на какое количество времени может быть отложено
 	выполнение задачи, если в момент запуска по расписанию уже запущено
 	максимально возможное количество задач. Время задается в формате 
@@ -296,10 +303,10 @@ JSONB объект может содержат следующие ключи, н
 *	**max\_run\_time** - определяет максимально возможное время выполнения 
 	задачи. Время задается в формате типа `interval`. Если время не определено,
 	то время исполнения не ограничено. По умолчанию время не определено;
-*	**onrollback** - SQL команда, которая будет выполнена если транзакция 
+*	**onrollback** - SQL команда, которая будет выполнена, если транзакция 
 	завершится аварийно. По умолчанию неопределена;
 *	**next\_time\_statement** - SQL команда, которая будет выполнена для
-	определения следующего времени записи задачи.
+	определения следующего времени запуска задачи.
 
 Правила для вычисления расписания выполнения задачи могут быть заданы в виде 
 строки cron (ключ `cron`), а так же в виде JSONВ объекта (ключ `rule`).
@@ -321,9 +328,9 @@ JSONB объект может содержат следующие ключи, н
 Все вышеописанные методы задания расписания могут быть скомбинированны между 
 собой. Но использование хотя бы одного из них обязательно.
 
-Ключ `next_time_statement` используется для того, что бы вычислить слеюующее 
+Ключ `next_time_statement` используется для того, что бы вычислить следующее 
 время выполнения задачи. Если он определен, то первое время выполнения задачи
-будет рассчитано с помощью методов приведенных выще, а последующие запуски будут
+будет рассчитано с помощью методов приведенных выше, а последующие запуски будут
 поставленны в расписание в то время, которое вернет SQL команда, указанная 
 в данном ключе. Команда должна возвращать запись, в первом поле которого 
 должно сожержаться значение следующего времени запуска типа `timestamp with time
@@ -348,7 +355,7 @@ SQL для вычисления следующего времени запуск
 
 Сами SQL команды задаются либо ключом `command`, либо ключом `commands`. 
 Первый это одна SQL команда, второй набор команд. На самом деле в ключ 
-`command` можно передать несколько команд разделенных точкой с запятой. Тогда
+`command` можно передать несколько команд, разделенных точкой с запятой. Тогда
 они все исполнятся в одной транзакции. Предпочтительно для набора команд
 использовать ключ `commands`, так как в сочетании с ключом
 `use_same_transaction`, вы можете задавать исполнение команд в одной транзакции
@@ -376,7 +383,6 @@ SQL для вычисления следующего времени запуск
 
 ### schedule.set_job_attribute(job_id integer, name text, value text || anyarray)
 
-The function allows to set exact property of existing job.
 Функция редактирует какое-то одно конкретное свойство существующей задачи.
 
 Аргументы:
@@ -393,6 +399,9 @@ The function allows to set exact property of existing job.
 Функция возвращает двоичное значение, true, если изменение успешное, false -
 в случае неуспеха.
 
+Пользователю, если он не суперпользователь, позволено менять свойства только
+тех задач, владельцем которых он является.
+
 ### schedule.deactivate_job(job_id integer)
 
 Функция деактивирует задачу и приостанавливает ее последующее выполнение.
@@ -467,7 +476,7 @@ The function allows to set exact property of existing job.
 Просматривать задачи, исполняемые другими пользователями,  может только 
 суперпользователь.
 
-Описание типа `cron_rec` смотрие в разделе **SQL типы**.
+Описание типа `cron_rec` смотрите в разделе **SQL типы**.
 
 ### schedule.get_user_active_jobs(username text)