@@ -358,97 +358,167 @@ SQL для вычисления следующего времени запуск
358358
359359Функция возвращает идентификатор созданной задачи.
360360
361- ###schedule.set_job_attributes(integer, jsonb)
361+ ###schedule.set_job_attributes(job_id integer, data jsonb)
362362
363- The function allows to edit settings of existing job.
363+ Данная функция позволяет редактировать свойства уже созданной задачи.
364364
365- First argument is ID of existing job, second argument is jsonb object
366- described in function` schedule.create_job ` . Some of keys may be omitted.
365+ Аргументы:
367366
368- Function returns boolean value - true on success and false on failure.
367+ * ** job_id** - идентификатор задачи
368+ * ** data** - JSONB объект, описывающий изменяемые свойства. Описание ключей и
369+ их структуру вы можете найти в описании функции `schedule.create_job`.
369370
370- User can edit only jobs it owns unless it's a superuser.
371+ Функция возвращает значение типа boolean - true - в случае удачи, false -
372+ в случае, если не удалось изменить свойства.
371373
372- ###schedule.set_job_attribute(integer, text, text || anyarray)
374+ Пользователю, если он не суперпользователь, позволено менять свойства только
375+ тех задач, владельцем которых он является.
376+
377+ ###schedule.set_job_attribute(job_id integer, name text, value text || anyarray)
373378
374379The function allows to set exact property of existing job.
380+ Функция редактирует какое-то одно конкретное свойство существующей задачи.
381+
382+ Аргументы:
383+
384+ * ** job_id** - идентификатор задачи
385+ * ** name** - название свойства
386+ * ** value** - значение свойства
387+
388+ Полный список свойств вы можете найти в описании функции` schedule.create_job ` .
389+ Значения некоторых свойств являются массивами, в этом случае вы можете
390+ передавать аргумент** value** как массив. Если свойство не массив, а значение
391+ передано как массив, возникнет ошибка.
375392
376- First argument is ID of existing job, second is name of the property - one
377- of the keys described in function ` schedule.create_job ` .
393+ Функция возвращает двоичное значение, true, если изменение успешное, false -
394+ в случае неуспеха .
378395
379- Function returns boolean value - true on success and false on failure.
396+ ### schedule.deactivate_job(job_id integer)
380397
381- ### schedule.deactivate_job(integer)
398+ Функция деактивирует задачу и приостанавливает ее последующее выполнение.
382399
383- The function allows to set cron job inactive. The job is not to be deleted
384- from cron table but its execution will be disabled.
400+ Аргументы:
385401
386- The first argument is ID of existing job.
402+ * ** job_id** - идентификатор задачи
403+
404+ Возвращает true в случае успеха.
387405
388406###schedule.activate_job(integer)
389407
390- The function allows to set cron job active.
408+ Функция активирует задачу. После чего задача начинает выполняться по расписанию.
409+
410+ Аргументы:
411+
412+ * ** job_id** - идентификатор задачи
413+
414+ Возвращает true в случае успеха.
391415
392- The first argument is ID of existing job.
393416
394417###schedule.drop_job(jobId integer)
395418
396- The function deletes cron job.
419+ Функция удаляет задачу.
420+
421+ Аргументы:
422+
423+ * ** job_id** - идентификатор задачи
424+
425+ Возвращает true в случае успеха.
426+
427+ ###schedule.get_job(job_id integer)
428+
429+ Функция возвращает информацию о задаче.
397430
398- The first argument is ID of existing job.
431+ Аргументы:
399432
400- ### schedule.get_job(int)
433+ * ** job_id ** - идентификатор задачи
401434
402- The function returns information about exact cron record.
435+ Возвращает информацию о задаче в виде записи типа` cron_rec ` . Описание вы
436+ можете найти в разделе** SQL типы** .
403437
404- It returns record of type ` cron_rec ` . See description above.
438+ ### schedule.get_user_owned_cron(username text)
405439
406- ### schedule.get_user_owned_cron(text)
440+ Функция возвращает список задач, принадлежащих пользователю.
407441
408- The function returns list of the jobs in cron table owned by user
409- passed in first argument or by session user if no user passed.
442+ Аргументы:
410443
411- It returns set of records of ` cron_rec ` type. See description above.
444+ * ** username ** - имя пользователя, опционально
412445
413- ###schedule.get_user_cron(text)
446+ Возвращает набор записей типа` cron_rec ` , которые принадлежат пользователю,
447+ указанному в аргументах. Если пользователь не указан, то возвращаются
448+ задачи, принадлежащие пользователю сессии.
414449
415- The function returns list of the jobs in cron table which will be executed
416- as user passed in first argument or by session user if no user passed .
450+ Просматривать задачи, принадлежащие другим пользователям, может только
451+ суперпользователь .
417452
418- It returns set of records of ` cron_rec ` type. See description above .
453+ Описание типа ` cron_rec ` смотрие в разделе ** SQL типы ** .
419454
420- ###schedule.get_user_active_jobs( text)
455+ ###schedule.get_user_cron(username text)
421456
422- The function returns all jobs executed at the moment as user passed in first
423- argument. If no user specified - session user used.
457+ Функция возвращает список задач, которые будут выполнены с правами пользователя.
424458
425- It returns set of records of` cron_job ` type. See description above.
459+ Аргументы:
460+
461+ * ** username** - имя пользователя, опционально
462+
463+ Возвращает набор записей типа` cron_rec ` , которые описывают задачи, которые
464+ будут выполняться с правами пользователя, указанного в аргументах.
465+ Если пользователь не указан, то то будет использоваться имя пользователя сессии.
466+
467+ Просматривать задачи, исполняемые другими пользователями, может только
468+ суперпользователь.
469+
470+ Описание типа` cron_rec ` смотрие в разделе** SQL типы** .
471+
472+ ###schedule.get_user_active_jobs(username text)
473+
474+ Функция возвращает список задач, которые исполняются в данный момент с правами
475+ пользователя переданного в аргументах.
476+
477+ Аргументы:
478+
479+ * ** username** - имя пользователя, опционально
480+
481+ Если не указано имя пользователя, то берется имя пользователя сессии. Чужие з
482+ задачи может просматривать только суперпользователь.
483+
484+ Задачи возвращаются в виде набора записей типа` cron_job ` . Описание типа вы
485+ можете найти в разделе** SQL типы** .
426486
427487###schedule.get_active_jobs()
428488
429- The function returns all jobs executed at the moment. Can be executed only
430- by superuser .
489+ Функция возвращает список всех задач, которые исполняются в данный момент.
490+ Может быть выполнена только пользователем с правами суперпользователя .
431491
432- It returns set of records of` cron_job ` type. See description above.
492+ Задачи возвращаются в виде набора записей типа` cron_job ` . Описание типа вы
493+ можете найти в разделе** SQL типы** .
433494
434495###schedule.get_log()
435496
436- The function returns all jobs which was executed. Can be executed only
437- by superuser.
497+ Функция возвращает список всех выполненых задач.
498+ Может быть выполнена только пользователем с правами суперпользователя.
499+
500+ Задачи возвращаются в виде набора записей типа` cron_job ` . Описание типа вы
501+ можете найти в разделе** SQL типы** .
502+
503+ ###schedule.get_user_log(username text)
504+
505+ Функция возвращает список всех выполненых задач, которые выполнялись с правами
506+ пользователя, переданного в аргументах.
438507
439- It returns set of records of ` cron_job ` type. See description above.
508+ Аргументы:
440509
441- ### schedule.get_user_log(text)
510+ * ** username ** - имя пользователя, опционально
442511
443- The function returns all jobs which was executed as user passed in first
444- argument. If no user specified - session user used .
512+ Если не указано имя пользователя, то используется имя пользователя сессии.
513+ Чужие задачи может просматривать только суперпользователь .
445514
446- It returns set of records of` cron_job ` type. See description above.
515+ Задачи возвращаются в виде набора записей типа` cron_job ` . Описание типа вы
516+ можете найти в разделе** SQL типы** .
447517
448518###schedule.clean_log()
449519
450- The function deletes all records in log table. Can be executed only by
451- superuser .
520+ Удаляет все записи о выполненных задачах. Может быть выполнена только с правами
521+ суперпользователя .
452522
453- Returns number of records deleted.
523+ Возвращает количество удаленных записей
454524