Lightning
v2.11.1
Pages
Modules
Mix
Tasks
API Reference
Modules
Mix Tasks
Lightning
Contents
Demo
Features
Getting Started
Security and Standards
Contribute to this project
Server Specs for Self-Hosting
Benchmarking
Troubleshooting
Support
Running Locally
By Installing Dependencies
Using Docker
Deployment
Encryption
Workers
Environment Variables
Benchmarking
Run benchmarking tests against the demo webhook
Run load tests for a hypothetical cold chain system
Workers
History
Connecting Workers to Lightning
Generating Keys
Configuring Lightning and Workers
Troubleshooting
Provisioning
Using the API
Document Structure
API Behaviour
Relationship with Projects as Code
Changelog
[Unreleased]
[v2.11.1-pre.1] - 2025-03-26
[v2.11.0] - 2025-03-19
[v2.10.16] - 2025-02-28
[v2.10.16-pre.0] - 2025-02-26
[v2.10.15] - 2025-02-14
[v2.10.14] - 2025-02-06
[v2.10.13] - 2025-01-29
[v2.10.12] - 2025-01-21
[v2.10.11] - 2025-01-21
[v2.10.10] - 2025-01-15
[v2.10.9] - 2025-01-09
[v2.10.8] - 2024-12-18
[v2.10.7] - 2024-12-13 🎂 ❤️ Happy Birthday, Mom!
[v2.10.6] - 2024-12-10
[v2.10.5] - 2024-12-04
[v2.10.4] - 2024-11-22
[v2.10.3] - 2024-11-13
[v2.10.2] - 2024-11-14
[v2.10.1] - 2024-11-13
[v2.10.0] - 2024-11-13
[v2.10.0-rc.2] - 2024-11-12
[v2.10.0-rc.1] - 2024-11-08
[v2.10.0-rc.0] - 2024-11-07
[v2.9.15] - 2024-11-06
[v2.9.14] - 2024-10-31
[v2.9.13] - 2024-10-28
[v2.9.12] - 2024-10-25
[v2.9.11] - 2024-10-23
[v2.9.10] - 2024-10-16
[v2.9.9] - 2024-10-09
[v2.9.8] - 2024-10-03
[v2.9.7] - 2024-10-02
[v2.9.6] - 2024-09-23
[v2.9.5] - 2024-09-18
[v2.9.4] - 2024-09-16
[v2.9.3] - 2024-09-11
[v2.9.2] - 2024-09-09
[v2.9.1] - 2024-09-09
[v2.9.0] - 2024-09-06
[v2.8.2] - 2024-09-04
[v2.8.1] - 2024-08-28
[v2.8.0] - 2024-08-27
[v2.7.19] - 2024-08-19
[v2.7.18] - 2024-08-17
[v2.7.17] - 2024-08-14
[v2.7.16] - 2024-08-07
[v2.7.15] - 2024-08-07
[v2.7.14] - 2024-08-05
[v2.7.13] - 2024-08-05
[v2.7.12] - 2024-07-31
[v2.7.11] - 2024-07-26
[v2.7.10]
[v2.7.9] - 2024-07-24
[v2.7.8] - 2024-07-24
[v2.7.7] - 2024-07-18
[v2.7.6] - 2024-07-11
[v2.7.5] - 2024-07-10
[v2.7.4] - 2024-07-06
[v2.7.3] - 2024-07-05
[v2.7.2] - 2024-07-03
[v2.7.1] - 2024-07-01
[v2.7.0] - 2024-06-26
[v2.6.3] - 2024-06-19
[v2.6.2] - 2024-06-13
[v2.6.1] - 2024-06-12
[v2.6.0] - 2024-06-05
[v2.5.5] - 2024-06-05
[v2.5.4] - 2024-05-31
[v2.5.3] - 2024-05-27
[v2.5.2] - 2024-05-23
[v2.5.1] - 2024-05-21
[v2.5.0] - 2024-05-20
[v2.5.0-pre4] - 2024-05-20
[v2.5.0-pre3] - 2024-05-20
[v2.5.0-pre2] - 2024-05-17
[v2.5.0-pre] - 2024-05-17
[v2.4.14] - 2024-05-16
[v2.4.13] - 2024-05-16
[v2.4.12] - 2024-05-15
[v2.4.11] - 2024-05-15
[v2.4.10] - 2024-05-14
[v2.4.9] - 2024-05-14
[v2.4.8] - 2024-05-13
[v2.4.7] - 2024-05-11
[v2.4.6] - 2024-05-08
[v2.4.5] - 2024-05-07
[v2.4.4] - 2024-05-03
[v2.4.3] - 2024-05-01
[v2.4.2] - 2024-04-24
[v2.4.1] - 2024-04-19
[v2.4.1-pre] - 2024-04-18
[v2.4.0] - 2024-04-12
[v2.3.1] - 2024-04-03
[v2.3.0] - 2024-04-02
[v2.2.2] - 2024-04-01
[v2.2.1] - 2024-03-27
[v2.2.0] - 2024-03-21
[v2.1.0] - 2024-03-20
[v2.0.10]
[v2.0.9] - 2024-03-19
[v2.0.8] - 2024-02-29
[v2.0.6] - 2024-02-29
[v2.0.5] - 2024-02-25
[v2.0.4] - 2024-02-24
[v2.0.3] - 2024-02-21
[v2.0.2] - 2024-02-14
[v2.0.1] - 2024-02-13
[v2.0.0] - 2024-02-10
[v2.0.0-rc12] - 2024-02-09
[v2.0.0-rc11] - 2024-02-08
[v2.0.0-rc10] - 2024-02-08
[v2.0.0-rc9] 2024-02-05
[v2.0.0-rc8] - 2024-01-30
[v2.0.0-rc7] - 2024-01-26
[v2.0.0-rc5] - 2024-01-22
[v2.0.0-rc4] - 2024-01-19
[v2.0.0-rc3] 2024-01-12
[2.0.0-rc2] - 2024-01-08
[2.0.0-rc1] - 2024-01-05
[v0.12.2] - 2023-12-24
[v0.12.1] - 2023-12-21
[v0.12.0] - 2023-12-15
[v0.11.0] - 2023-12-06
[v0.10.6] - 2023-12-05
[v0.10.5] - 2023-12-03
[v0.10.4] - 2023-11-30
[v0.10.3] - 2023-11-28
[v0.10.2] - 2023-11-21
[v0.10.1] - 2023-11-21
[v0.10.0] - 2023-11-21
[v0.9.3] - 2023-09-27
[v0.9.2] - 2023-09-20
[v0.9.1] - 2023-09-19
[v0.9.0] - 2023-09-15
[v0.8.3] - 2023-09-05
[v0.8.2] - 2023-08-31
[v0.8.1] - 2023-08-31
[v0.8.0] - 2023-08-31
[v0.7.3] - 2023-08-15
[v0.7.2] - 2023-08-10
[v0.7.1] - 2023-08-04
[v0.7.0] - 2023-08-04
[v0.7.0-pre5] - 2023-07-28
[v0.7.0-pre4] - 2023-07-27
[v0.7.0-pre3] - 2023-07-26
[v0.7.0-pre2] - 2023-07-26
[0.6.7] - 2023-07-13
[0.6.6] - 2023-06-30
[0.6.5] - 2023-06-22
[0.6.3] - 2023-06-15
[0.6.2] - 2023-06-09
[0.6.1] - 2023-06-08
[0.6.0]- 2023-04-12
[0.5.2]
[0.5.1] - 2023-04-12
[0.5.0] - 2023-04-03
[0.4.8] - 2023-03-29
[0.4.6] - 2023-03-23
[0.4.4] - 2023-03-10
[0.4.3] - 2023-03-06
[0.4.2] - 2023-02-24
[0.4.0] - 2023-02-08
[0.3.1] - 2022-11-22
[0.3.0] - 2022-11-21
[0.2.0] - 2022-09-12
[0.1.13] - 2022-08-29
[0.1.12] - 2022-08-15
[0.1.11] - 2022-08-05
[0.1.10] - 2022-08-05
[0.1.9] - 2022-07-27
[0.1.7] - 2022-06-24
[0.1.6] - 2022-06-07
Lightning
Summary
Types
release_info/0
Callbacks
broadcast/2
current_time/0
local_broadcast/2
release/0
subscribe/1
Functions
broadcast/2
current_time/0
local_broadcast/2
release/0
subscribe/1
ObanPruner
Summary
Functions
perform/1
React
Summary
Functions
component_id/1
get_entry_points/1
json/1
jsx/1
React.Component
Sections
Example
Accounts
Lightning.Accounts
Summary
Functions
apply_user_email/3
cancel_scheduled_deletion/1
change_scheduled_deletion/2
change_superuser_registration/1
change_user/2
change_user_email/2
change_user_info/2
change_user_password/2
change_user_registration/1
confirm_user/1
confirmation_required?/1
create_user/1
delete_auth_token/1
delete_session_token/1
delete_sudo_session_token/1
delete_token/1
delete_user/1
delete_user_totp/1
deliver_user_confirmation_instructions/1
deliver_user_confirmation_instructions/2
deliver_user_reset_password_instructions/2
exchange_auth_token/1
generate_api_token/1
generate_auth_token/1
generate_sudo_session_token/1
generate_user_session_token/1
get_preference/2
get_token!/1
get_user/1
get_user!/1
get_user_by_api_token/1
get_user_by_auth_token/1
get_user_by_email/1
get_user_by_email_and_password/2
get_user_by_reset_password_token/1
get_user_by_session_token/1
get_user_totp/1
get_users_to_alert_for_project/1
has_activity_in_projects?/1
has_one_superuser?/0
list_api_tokens/1
list_user_backup_codes/1
list_users/0
list_users_by_emails/1
perform/1
purge_user/1
regenerate_user_backup_codes/1
register_superuser/1
register_user/1
remind_account_confirmation/1
request_email_update/2
reset_user_password/2
schedule_user_deletion/2
subscribe/0
sudo_session_token_valid?/2
update_user_details/2
update_user_email/2
update_user_info/2
update_user_password/3
update_user_preference/3
update_user_preferences/2
upsert_user_totp/2
valid_user_backup_code?/2
valid_user_totp?/2
validate_change_user_email/2
Lightning.Accounts.Events
Summary
Functions
subscribe/0
user_registered/1
Lightning.Accounts.User
Summary
Types
t/0
Functions
changeset/2
confirm_changeset/1
details_changeset/2
email_changeset/2
github_token_changeset/2
info_changeset/2
password_changeset/3
preferences_changeset/2
remove_github_token_changeset/1
scheduled_deletion_changeset/2
superuser_registration_changeset/2
user_registration_changeset/2
valid_password?/2
validate_current_password/2
validate_email/1
validate_email_exists/1
validate_email_format/1
Lightning.Accounts.User.RolesEnum
Summary
Types
t/0
Functions
cast/1
create_type/0
drop_type/0
dump/1
embed_as/1
equal?/2
load/1
schema/0
schemaless_type/0
type/0
valid_value?/1
Lightning.Accounts.UserBackupCode
Summary
Types
t/0
Functions
changeset/2
generate_backup_code/0
Lightning.Accounts.UserNotifier
Summary
Functions
build_digest_url/3
deliver_confirmation_instructions/2
deliver_confirmation_instructions/3
deliver_credential_transfer_confirmation_instructions/4
deliver_credential_transfer_notification/3
deliver_project_addition_notification/2
deliver_project_digest/2
deliver_project_invitation_email/5
deliver_reset_password_instructions/2
deliver_update_email_instructions/2
deliver_update_email_warning/2
notify_history_export_completion/2
notify_project_deletion/2
remind_account_confirmation/2
send_credential_deletion_notification_email/2
send_data_retention_change_email/2
send_deletion_notification_email/1
send_trigger_failure_mail/3
Lightning.Accounts.UserTOTP
Summary
Types
t/0
Functions
changeset/2
valid_totp?/2
Lightning.Accounts.UserToken
Summary
Functions
build_email_token/3
build_token/2
changeset/2
last_used_changeset/1
token_and_context_query/2
user_and_contexts_query/2
verify_change_email_token_query/2
verify_email_token_query/2
verify_token_query/2
Config
Lightning.Config
Summary
Callbacks
adaptor_registry/0
apollo/1
book_demo_banner_enabled?/0
book_demo_calendly_url/0
book_demo_openfn_workflow_url/0
check_flag?/1
cors_origin/0
credential_transfer_token_validity_in_days/0
default_max_run_duration/0
email_sender_name/0
gdpr_banner/0
gdpr_preferences/0
get_extension_mod/1
google/1
grace_period/0
instance_admin_email/0
kafka_alternate_storage_enabled?/0
kafka_alternate_storage_file_path/0
kafka_duplicate_tracking_retention_seconds/0
kafka_notification_embargo_seconds/0
kafka_number_of_consumers/0
kafka_number_of_messages_per_second/0
kafka_number_of_processors/0
kafka_triggers_enabled?/0
oauth_provider/1
promex_metrics_endpoint_authorization_required?/0
promex_metrics_endpoint_scheme/0
promex_metrics_endpoint_token/0
purge_deleted_after_days/0
repo_connection_token_signer/0
reset_password_token_validity_in_days/0
run_token_signer/0
storage/0
storage/1
token_signer/0
ui_metrics_tracking_enabled?/0
usage_tracking/0
usage_tracking_cleartext_uuids_enabled?/0
usage_tracking_cron_opts/0
usage_tracking_enabled?/0
usage_tracking_host/0
usage_tracking_run_chunk_size/0
worker_secret/0
worker_token_signer/0
Functions
adaptor_registry/0
apollo/1
book_demo_banner_enabled?/0
book_demo_calendly_url/0
book_demo_openfn_workflow_url/0
check_flag?/1
cors_origin/0
credential_transfer_token_validity_in_days/0
default_max_run_duration/0
email_sender_name/0
gdpr_banner/0
gdpr_preferences/0
get_extension_mod/1
google/1
grace_period/0
instance_admin_email/0
kafka_alternate_storage_enabled?/0
kafka_alternate_storage_file_path/0
kafka_duplicate_tracking_retention_seconds/0
kafka_notification_embargo_seconds/0
kafka_number_of_consumers/0
kafka_number_of_messages_per_second/0
kafka_number_of_processors/0
kafka_triggers_enabled?/0
oauth_provider/1
promex_metrics_endpoint_authorization_required?/0
promex_metrics_endpoint_scheme/0
promex_metrics_endpoint_token/0
purge_deleted_after_days/0
repo_connection_token_signer/0
reset_password_token_validity_in_days/0
run_token_signer/0
storage/0
storage/1
token_signer/0
ui_metrics_tracking_enabled?/0
usage_tracking/0
usage_tracking_cleartext_uuids_enabled?/0
usage_tracking_cron_opts/0
usage_tracking_enabled?/0
usage_tracking_host/0
usage_tracking_run_chunk_size/0
worker_secret/0
worker_token_signer/0
Lightning.Config.Bootstrap
Summary
Functions
configure/0
get_env/2
source_envs/0
Lightning.Config.Utils
Summary
Functions
ensure_boolean/1
get_env/2
Runs
Lightning.Runs
Summary
Functions
append_run_log/3
complete_run/2
complete_step/2
enqueue/1
get/2
get_credential/2
get_dataclip_body/1
get_dataclip_request/1
get_for_worker/1
get_input/1
get_log_lines/2
get_project_id_for_run/1
get_run_options/2
mark_run_lost/1
mark_steps_lost/1
start_run/2
start_step/2
subscribe/1
update_run/1
update_runs/2
wipe_dataclips/1
Lightning.Runs.Handlers
Lightning.Runs.Handlers.CompleteRun
Summary
Functions
call/2
new/1
Lightning.Runs.Handlers.CompleteStep
Summary
Functions
call/2
new/2
Lightning.Runs.Handlers.StartRun
Summary
Functions
call/2
new/1
Lightning.Runs.Handlers.StartStep
Summary
Functions
call/2
Lightning.Runs.PromExPlugin
Summary
Functions
calculate_average_claim_duration/2
count_finalised_runs/1
run_queue_metrics/2
stalled_run_count/1
Lightning.Runs.Query
Summary
Functions
eligible_for_claim/0
in_progress_window/0
lost/0
lost_steps/0
Lightning.Runs.Queue
Summary
Functions
claim/2
Lightning.Runs.RunOptions
Summary
Types
keyword_list/0
t/0
Functions
new/1
WorkOrders
Lightning.WorkOrders
Sections
Work Orders
Creating Work Orders
Summary
Types
work_order_option/0
Functions
build_for/2
create_for/1
create_for/3
enqueue_many_for_retry/2
get/2
get_last_runs_steps_with_dataclips/2
retry/3
retry_many/2
retry_many/3
subscribe/1
update_state/1
Lightning.WorkOrders.ExportAudit
Summary
Functions
base_query/0
event/5
save/1
update_changes/1
Lightning.WorkOrders.ExportWorker
Summary
Functions
enqueue_export/3
extract_entities/1
fetch_dataclips/1
Lightning.WorkOrders.Manual
Summary
Types
t/0
Functions
new/2
Lightning.WorkOrders.Query
Summary
Functions
state_for/1
Lightning.WorkOrders.RetryManyWorkOrdersJob
Lightning.WorkOrders.SearchParams
Summary
Types
t/0
Functions
all_statuses_set?/1
from_map/1
new/1
status_list/0
to_uri_params/1
Credentials
Lightning.Credentials
Summary
Types
transfer_error/0
Functions
basic_auth_for/1
cancel_scheduled_deletion/1
change_credential/2
confirm_transfer/4
create_credential/1
credential_transfer_changeset/0
credential_transfer_changeset/1
delete_credential/1
find_best_matching_token_for_scopes/3
get_credential/1
get_credential!/1
get_credential_by_project_credential/1
get_credential_for_update!/1
get_schema/1
has_activity_in_projects?/1
initiate_credential_transfer/3
list_credentials/1
list_user_credentials_in_project/2
lookup_adapter/1
maybe_refresh_token/1
normalize_keys/1
normalize_scopes/1
normalize_scopes/2
perform/1
revoke_transfer/2
schedule_credential_deletion/1
sensitive_values_for/1
still_fresh/3
update_credential/2
validate_credential_transfer/3
validate_oauth_token_data/5
Lightning.Credentials.Audit
Summary
Functions
base_query/0
event/5
save/1
update_changes/1
user_initiated_event/3
Lightning.Credentials.Credential
Summary
Types
t/0
Lightning.Credentials.OauthClient
Summary
Types
t/0
Functions
changeset/2
Lightning.Credentials.OauthClientAudit
Summary
Functions
base_query/0
event/5
save/1
update_changes/1
user_initiated_event/3
Lightning.Credentials.OauthMigration
Summary
Functions
run/0
Lightning.Credentials.OauthToken
Summary
Types
t/0
Functions
changeset/1
changeset/2
extract_scopes/1
update_token_changeset/2
Lightning.Credentials.Schema
Summary
Types
t/0
Functions
new/2
properties/2
required?/2
validate/2
Lightning.Credentials.SchemaDocument
Summary
Functions
changeset/3
Lightning.Credentials.SensitiveValues
Summary
Types
pairs/0
raw_pairs/0
Functions
flatten_map/1
secret_values/1
Invocations
Lightning.Invocation
Summary
Functions
assemble_logs_for_step/1
change_dataclip/2
change_step/2
count_workorders/2
create_dataclip/1
delete_dataclip/1
export_workorders/3
get_dataclip/1
get_dataclip!/1
get_dataclip_details!/1
get_dataclip_for_run/1
get_dataclip_query/1
get_first_dataclip_for_run_and_job/2
get_first_step_for_run_and_job/2
get_output_dataclip_query/1
get_step!/1
get_step_count_for_run/1
get_step_with_job!/1
get_workorders_by_ids/1
get_workorders_count_limit/0
list_dataclips/0
list_dataclips/1
list_dataclips_for_job/1
list_dataclips_query/1
list_steps/0
list_steps_for_project/2
list_steps_for_project_query/1
logs_for_step/1
search_workorders/1
search_workorders/3
search_workorders_for_export_query/2
search_workorders_for_retry/2
update_dataclip/2
with_runs/1
Lightning.Invocation.Dataclip
Sections
Types
Summary
Types
source_type/0
t/0
Functions
new/1
source_types/0
validate_by_type/1
Lightning.Invocation.LogLine
Summary
Types
t/0
Functions
new/3
validate/2
Lightning.Invocation.Query
Summary
Functions
any_step/0
dataclip_with_body/0
last_n_for_job/2
last_step_for_job/1
last_successful_step_for_job/1
select_as_input/1
steps_for/1
steps_with_reason/2
wipe_dataclips/1
Lightning.Invocation.Step
Summary
Types
t/0
Functions
finished/2
new/1
validate/1
Jobs
Lightning.Jobs
Summary
Functions
change_job/2
create_job/2
get_downstream_jobs_for/2
get_job!/1
get_job_with_credential/1
get_upstream_jobs_for/1
jobs_for_project/1
jobs_for_project_query/1
list_active_cron_jobs/0
list_jobs/0
list_jobs_for_workflow/1
update_job/2
Projects
Lightning.Projects
Summary
Functions
add_project_users/3
cancel_scheduled_deletion/1
change_project/2
create_project/2
delete_project/1
delete_project_async/1
delete_project_dataclips/2
delete_project_user!/1
delete_project_workorders/2
export_project/3
find_users_to_notify_of_trigger_failure/1
get_project/1
get_project!/1
get_project_credential/2
get_project_user/1
get_project_user/2
get_project_user!/1
get_project_user_role/2
get_project_users!/1
get_project_with_users!/1
get_projects_for_user/2
get_projects_overview/2
invite_collaborators/3
list_project_admin_emails/1
list_project_credentials/1
list_project_files/2
list_projects/0
list_projects_having_history_retention/0
member_of?/2
perform/1
project_credentials_query/1
project_dataclips_query/1
project_jobs_query/1
project_run_step_query/1
project_runs_query/1
project_steps_query/1
project_triggers_query/1
project_user_role_query/2
project_users_query/1
project_workflows_query/1
project_workorders_query/1
projects_for_user_query/2
save_dataclips?/1
schedule_project_deletion/1
scheduled_project_deletion_changes/2
select_first_project_for_user/1
update_project/3
update_project_user/2
update_project_with_users/3
validate_for_deletion/2
Lightning.Projects.Audit
Summary
Functions
base_query/0
derive_events/3
event/5
save/1
update_changes/1
Lightning.Projects.Events
Summary
Functions
project_created/1
project_deleted/1
subscribe/0
Lightning.Projects.File
Summary
Types
t/0
Functions
mark_failed/1
new/1
Lightning.Projects.Project
Summary
Types
retention_policy_type/0
t/0
Functions
data_retention_options/0
deletion_changeset/2
project_with_users_changeset/2
validate/1
Lightning.Projects.ProjectCredential
Summary
Types
t/0
Lightning.Projects.ProjectOauthClient
Sections
Schema Information
Usage
Summary
Types
t/0
Functions
changeset/2
Lightning.Projects.ProjectOverviewRow
Lightning.Projects.ProjectUser
Summary
Types
t/0
Lightning.Projects.ProjectUser.DigestEnum
Summary
Types
t/0
Functions
cast/1
create_type/0
drop_type/0
dump/1
embed_as/1
equal?/2
load/1
schema/0
schemaless_type/0
type/0
valid_value?/1
Lightning.Projects.ProjectUser.RolesEnum
Summary
Types
t/0
Functions
cast/1
create_type/0
drop_type/0
dump/1
embed_as/1
equal?/2
load/1
schema/0
schemaless_type/0
type/0
valid_value?/1
Lightning.Projects.Provisioner
Summary
Functions
import_document/3
parse_document/2
preload_dependencies/2
validate_extraneous_params/1
Runtime
Lightning.Runtime.LogAgent
Summary
Types
logline/0
Functions
buffer/1
child_spec/1
process_chunk/2
start_link/1
Lightning.Runtime.LogAgent.StringBuffer
Summary
Types
t/0
Functions
buffer/1
new/0
process_chunk/2
reduce_chunk/2
Lightning.Runtime.RuntimeManager
Sections
Runtime configuration
Summary
Functions
child_spec/1
start_link/1
Lightning.Runtime.RuntimeManager.RuntimeClient
Summary
Callbacks
start_runtime/1
stop_runtime/1
Workflows
Lightning.Workflows
Summary
Functions
build_trigger/1
capture_snapshot/1
change_workflow/2
create_edge/2
get_edge_by_trigger/1
get_edges_for_cron_execution/1
get_trigger_by_webhook/1
get_webhook_trigger/2
get_workflow/2
get_workflow!/2
get_workflows_for/1
has_newer_version?/1
jobs_ordered_subquery/0
list_project_workflows/2
list_workflows/0
mark_for_deletion/3
publish_kafka_trigger_events/1
save_workflow/2
subscribe/1
to_project_space/1
update_trigger/2
update_triggers_enabled_state/2
workflow_exists?/2
Lightning.Workflows.Audit
Summary
Functions
base_query/0
event/5
marked_for_deletion/2
past_tense/1
provisioner_event/3
save/1
snapshot_created/3
update_changes/1
workflow_state_changed/4
Lightning.Workflows.Edge
Summary
Types
edge_condition/0
t/0
Functions
changeset/2
new/1
validate/1
Lightning.Workflows.Job
Summary
Types
t/0
Functions
new/1
put_project_credential/2
put_workflow/2
validate/1
Lightning.Workflows.Node
Lightning.Workflows.Presence
Summary
Functions
build_presences_summary/2
child_spec/1
fetch/2
fetchers_pids/0
get_by_key/2
has_any_presence?/1
list/1
list_presences_for/1
new_user_presence/3
track/3
track/4
track_user_presence/3
untrack/2
untrack/3
untrack_user_presence/3
update/3
update/4
Lightning.Workflows.Query
Summary
Functions
enabled_cron_jobs_by_edge/0
jobs_for/1
Lightning.Workflows.Scheduler
Summary
Functions
enqueue_cronjobs/0
enqueue_cronjobs/1
Lightning.Workflows.Snapshot
Summary
Types
t/0
Functions
build/1
create/1
get_all_by_ids/1
get_all_for/1
get_by_version/2
get_current_for/1
include_latest_snapshot/3
new/1
Lightning.Workflows.Snapshot.Edge
Lightning.Workflows.Snapshot.Job
Lightning.Workflows.Snapshot.Trigger
Lightning.Workflows.Trigger
Sections
Types
Summary
Types
t/0
trigger_type/0
Functions
cast_changeset/2
new/1
validate/1
with_auth_methods_query/0
Lightning.Workflows.Triggers.Events
Summary
Functions
kafka_trigger_notification_sent/2
kafka_trigger_updated/1
kafka_trigger_updated_topic/0
subscribe_to_kafka_trigger_updated/0
Lightning.Workflows.Triggers.KafkaConfiguration
Summary
Functions
apply_hosts_string/1
apply_topics_string/1
changeset/2
generate_hosts_string/1
generate_topics_string/1
sasl_types/0
set_group_id_if_required/1
validate_initial_offset_reset_policy/1
validate_sasl_credentials/1
Lightning.Workflows.WebhookAuthMethod
Sections
Schema
Associations
Validations and Constraints
Password Verification
Summary
Types
t/0
Functions
changeset/2
generate_api_key/1
update_changeset/2
Lightning.Workflows.WebhookAuthMethodAudit
Summary
Functions
base_query/0
event/5
save/1
Lightning.Workflows.Workflow
Summary
Types
t/0
Functions
request_deletion_changeset/2
touch/1
validate/1
workflow_activated?/1
Custom Data Types
Lightning.LogMessage
Summary
Functions
cast/1
dump/1
embed_as/1
equal?/2
load/1
type/0
Lightning.UnixDateTime
Summary
Functions
cast/1
dump/1
embed_as/1
equal?/2
load/1
type/0
Web
LightningWeb
Summary
Functions
__using__/1
channel/0
component/0
controller/0
html/0
live_component/0
live_view/1
router/0
static_paths/0
verified_routes/0
view/0
LightningWeb.API.Helpers
Summary
Functions
pagination_link/3
pagination_links/2
url_for/2
LightningWeb.API.JobController
Summary
Functions
index/2
show/2
LightningWeb.API.ProjectController
Summary
Functions
index/2
show/2
LightningWeb.API.ProvisioningController
Summary
Functions
create/2
show/2
show_yaml/2
LightningWeb.API.RegistrationController
Summary
Functions
create/2
LightningWeb.API.WorkflowsController
Summary
Functions
create/2
index/2
show/2
update/2
LightningWeb.AccountConfirmationModal
Sections
Features
Usage
Examples
LightningWeb.AuditLive.Index
Summary
Functions
diff/1
render/1
LightningWeb.AuthProvidersLive.FormComponent
LightningWeb.AuthProvidersLive.Index
LightningWeb.BackupCodesController
Summary
Functions
print/2
LightningWeb.BackupCodesLive.Index
Summary
Functions
render/1
LightningWeb.ChangesetJSON
Summary
Functions
errors/1
LightningWeb.ChangesetView
Summary
Functions
__resource__/0
render/2
template_not_found/2
LightningWeb.ChannelHelpers
Summary
Functions
reply_with/2
LightningWeb.CollectionLive.CollectionCreationModal
LightningWeb.CollectionLive.Components
Summary
Functions
collections_table/1
LightningWeb.CollectionLive.Index
LightningWeb.CollectionsController
Summary
Functions
delete/2
delete_all/2
get/2
put/2
put_all/2
stream/2
LightningWeb.CollectionsController.ChunkAcc
LightningWeb.Components.Loaders
Summary
Functions
button_loader/1
offline_indicator/1
text_ping_loader/1
LightningWeb.Components.Menu
Summary
Functions
menu_item/1
profile_items/1
project_items/1
LightningWeb.Components.Modal
Summary
Functions
hide_modal/2
modal/1
modal_footer/1
show_modal/2
LightningWeb.Components.NewInputs
Summary
Functions
button/1
checkbox_element/1
error/1
errors/1
form_hidden_inputs/1
input/1
input_element/1
label/1
simple_button_with_tooltip/1
textarea_element/1
LightningWeb.Components.Pills
Summary
Functions
pill/1
LightningWeb.Components.Viewers
Summary
Functions
dataclip_viewer/1
log_viewer/1
step_dataclip_viewer/1
wiped_dataclip_viewer/1
LightningWeb.CredentialLive.CredentialFormComponent
LightningWeb.CredentialLive.GenericOauthComponent
LightningWeb.CredentialLive.Helpers
Summary
Functions
filter_available_projects/2
handle_save_response/2
prepare_projects_associations/3
select_project/4
unselect_project/3
LightningWeb.CredentialLive.Index
Summary
Functions
delete_action/1
handle_info/2
render/1
LightningWeb.CredentialLive.JsonSchemaBodyComponent
Summary
Functions
fieldset/1
schema_input/1
LightningWeb.CredentialLive.OauthClientFormComponent
Summary
Functions
global_client_checkbox/1
LightningWeb.CredentialLive.OauthComponent
Summary
Functions
fieldset/1
LightningWeb.CredentialLive.RawBodyComponent
Summary
Functions
fieldset/1
LightningWeb.CredentialLive.TransferCredentialModal
LightningWeb.CredentialTransferController
Summary
Functions
confirm/2
LightningWeb.DashboardLive.Components
Summary
Functions
user_projects_table/1
welcome_banner/1
LightningWeb.DashboardLive.Index
LightningWeb.DashboardLive.ProjectCreationModal
LightningWeb.DashboardLive.UserProjectsSection
LightningWeb.DashboardLive.WelcomeSection
LightningWeb.DataclipController
Summary
Functions
show/2
LightningWeb.DataclipLive.FormComponent
Summary
Functions
render/1
LightningWeb.DataclipLive.Show
LightningWeb.DownloadsController
Summary
Functions
download_project_yaml/2
LightningWeb.DynamicComponent
Summary
Types
t/0
Functions
dynamic_component?/1
LightningWeb.Endpoint
Summary
Functions
broadcast/3
broadcast!/3
broadcast_from/4
broadcast_from!/4
call/2
child_spec/1
config/2
config_change/2
host/0
init/1
local_broadcast/3
local_broadcast_from/4
path/1
script_name/0
server_info/1
start_link/1
static_integrity/1
static_lookup/1
static_path/1
static_url/0
struct_url/0
subscribe/2
unsubscribe/1
url/0
LightningWeb.FallbackController
LightningWeb.FirstSetupLive.Superuser
Summary
Functions
render/1
LightningWeb.FormHelpers
LightningWeb.Gettext
Summary
Functions
dgettext/3
dgettext_noop/2
dngettext/5
dngettext_noop/3
dpgettext/4
dpgettext_noop/3
dpngettext/6
dpngettext_noop/4
gettext/2
gettext_comment/1
gettext_noop/1
handle_missing_bindings/2
handle_missing_plural_translation/7
handle_missing_translation/5
lgettext/5
lngettext/7
ngettext/4
ngettext_noop/2
pgettext/3
pgettext_noop/2
pngettext/5
pngettext_noop/3
LightningWeb.HealthCheck
Summary
Functions
call/2
init/1
LightningWeb.Hooks
Summary
Functions
on_mount/4
LightningWeb.InitAssigns
Summary
Functions
on_mount/4
LightningWeb.JobLive.AdaptorPicker
Summary
Functions
display_name_for_adaptor/1
get_adaptor_version_options/1
render/1
LightningWeb.JobLive.CredentialPicker
Summary
Functions
render/1
LightningWeb.JobLive.CronSetupComponent
Sections
Usage
Summary
Functions
build_cron_expression/2
frequency_field/1
get_cron_data/1
hour_field/1
minute_field/1
monthday_field/1
render/1
time_field/1
weekday_field/1
LightningWeb.JobLive.JobBuilderComponents
Summary
Functions
job_editor_component/1
LightningWeb.JobLive.KafkaSetupComponent
Summary
Functions
render/1
LightningWeb.LiveHelpers
Summary
Functions
book_demo_banner/1
check_limits/2
display_short_uuid/1
fade_in/1
fade_out/1
live_error_block/1
live_info_block/1
live_nav_block/1
upcase_first/1
LightningWeb.ModalPortal
Summary
Functions
close_modal/0
handle_event/3
on_hide/2
on_show/2
open_modal/2
render/1
update/2
LightningWeb.OauthController
Summary
Functions
new/2
LightningWeb.OauthCredentialHelper
Summary
Functions
broadcast/2
broadcast_forward/3
build_state/3
decode_state/1
subscribe/1
LightningWeb.OidcController
Summary
Functions
new/2
show/2
LightningWeb.PageView
Summary
Functions
__resource__/0
render/2
template_not_found/2
LightningWeb.Pagination
Summary
Functions
page_link/1
pagination_bar/1
raw_pagination_links/2
LightningWeb.PlugConfigs
Summary
Functions
plug_parsers/0
LightningWeb.Plugs.ApiAuth
LightningWeb.Plugs.BlockRoutes
LightningWeb.Plugs.FirstSetup
LightningWeb.Plugs.MetricsAuth
Summary
Functions
call/2
init/1
LightningWeb.Plugs.PromexWrapper
Summary
Functions
call/2
init/1
LightningWeb.Plugs.Redirect
Summary
Functions
call/2
init/1
LightningWeb.Plugs.WebhookAuth
Summary
Functions
call/2
init/1
LightningWeb.ProfileLive.Components
Summary
Functions
action_cards/1
user_info/1
LightningWeb.ProfileLive.Edit
Summary
Functions
render/1
LightningWeb.ProfileLive.FormComponent
Summary
Functions
enum_options/2
render/1
LightningWeb.ProfileLive.MfaComponent
Summary
Functions
render/1
LightningWeb.ProjectFileController
Summary
Functions
download/2
LightningWeb.ProjectLive.Collaborators
Summary
Functions
changeset/2
prepare_for_insertion/3
LightningWeb.ProjectLive.Collaborators.Collaborator
LightningWeb.ProjectLive.ConcurrencyInputComponent
Summary
Functions
render/1
update/2
LightningWeb.ProjectLive.FormComponent
Summary
Functions
render/1
LightningWeb.ProjectLive.Index
Summary
Functions
delete_action/1
render/1
LightningWeb.ProjectLive.InvitedCollaborators
Summary
Functions
changeset/2
validate_collaborators/2
LightningWeb.ProjectLive.InvitedCollaborators.InvitedCollaborator
LightningWeb.ProjectLive.MFARequired
Summary
Functions
on_mount/4
render/1
LightningWeb.ProjectLive.Settings
Summary
Functions
digest/1
permissions_message/1
render/1
role/1
user/1
LightningWeb.ReAuthenticateLive.New
Summary
Functions
render/1
LightningWeb.RouteHelpers
Summary
Functions
oidc_callback_url/0
project_dashboard_url/1
LightningWeb.Router
Summary
Functions
api/2
authenticated_api/2
browser/2
call/2
init/1
storybook_assets/2
storybook_browser/2
LightningWeb.RunChannel
Summary
Functions
child_spec/1
handle_in/3
start_link/1
LightningWeb.RunLive.ExportConfirmationModal
LightningWeb.RunLive.Index
Summary
Functions
checked?/2
filters_changeset/1
handle_info/2
render/1
validate_bulk_rerun/2
LightningWeb.RunLive.RerunJobComponent
LightningWeb.RunLive.RunViewerLive
Summary
Functions
apply_selected_step_id/2
handle_steps_change/1
LightningWeb.RunLive.Show
Summary
Functions
apply_selected_step_id/2
handle_steps_change/1
LightningWeb.RunLive.Streaming
Summary
Functions
add_or_update_step/2
get_dataclip/2
get_run_async/2
maybe_load_input_dataclip/1
maybe_load_output_dataclip/1
sort_steps/1
unselect_step/1
LightningWeb.RunLive.WorkOrderComponent
Summary
Functions
render/1
LightningWeb.Telemetry
Summary
Functions
child_spec/1
metrics/0
start_link/1
with_span/3
LightningWeb.TokensLive.Index
Summary
Functions
render/1
LightningWeb.UiMetrics
Summary
Functions
log_job_editor_metrics/2
log_workflow_editor_metrics/2
LightningWeb.UserAuth
Summary
Functions
authenticate_bearer/2
fetch_current_user/2
get_bearer/1
log_in_user/2
log_out_user/1
mark_totp_pending/1
new_session/2
on_mount/4
reauth_sudo_mode/2
redirect_if_user_is_authenticated/2
redirect_with_return_to/2
require_authenticated_api_resource/2
require_authenticated_user/2
require_sudo_user/2
require_superuser/2
totp_pending?/1
totp_validated/1
LightningWeb.UserConfirmationController
Summary
Functions
confirm_email/2
create/2
edit/2
new/2
send_email/2
update/2
LightningWeb.UserLive.Components
Summary
Functions
users_table/1
LightningWeb.UserLive.Edit
Summary
Functions
render/1
LightningWeb.UserLive.FormComponent
Summary
Functions
render/1
user_options/0
LightningWeb.UserLive.Index
Summary
Functions
render/1
LightningWeb.UserRegistrationController
Summary
Functions
create/2
new/2
LightningWeb.UserResetPasswordController
Summary
Functions
create/2
edit/2
new/2
update/2
LightningWeb.UserSessionController
Summary
Functions
auth_handler_url/0
create/2
delete/2
exchange_token/2
new/2
LightningWeb.UserTOTPController
Summary
Functions
create/2
new/2
LightningWeb.Utils
Summary
Functions
add_dynamic_plugs/1
build_params_for_field/3
decode_one/2
pluralize_with_s/2
LightningWeb.VersionControlController
Summary
Functions
index/2
LightningWeb.WebhooksController
Summary
Functions
check/2
create/2
LightningWeb.WorkerChannel
Summary
Functions
child_spec/1
start_link/1
LightningWeb.WorkerSocket
Summary
Functions
handle_error/2
LightningWeb.WorkflowLive.AiAssistantComponent
Summary
Functions
error_message/1
formatted_content/1
handle_async/3
handle_event/3
mount/1
render/1
update/2
LightningWeb.WorkflowLive.EditorPane
Summary
Functions
render/1
LightningWeb.WorkflowLive.Helpers
Summary
Functions
broadcast_updated_params/2
run_workflow/3
save_workflow/2
subscribe_to_params_update/1
workflow_enabled?/1
workflow_state_tooltip/1
LightningWeb.WorkflowLive.JobView
Summary
Functions
container/1
job_edit_view/1
LightningWeb.WorkflowLive.NewWorkflowForm
Summary
Functions
validate/2
validate_for_save/1
LightningWeb.WorkflowNewLive.WorkflowParams
Summary
Functions
apply_form_params/2
apply_patches/2
to_map/1
to_patches/2
Other
Lightning.API
Lightning.AdaptorRegistry
Summary
Functions
all/1
child_spec/1
fetch/0
latest_for/2
local_adaptors_enabled?/0
resolve_adaptor/1
resolve_package_name/1
resolve_package_name!/1
start_link/1
versions_for/2
Lightning.AdaptorRegistry.Npm
Summary
Functions
client/0
package_detail/1
user_packages/1
Lightning.AdaptorService
Sections
Configuration
Installing Adaptors
Looking up adaptors
Summary
Types
package_spec/0
Functions
build_aliased_name/1
child_spec/1
find_adaptor/2
get_adaptors/1
install/2
install!/2
installed?/2
resolve_package_name/1
start_link/1
Lightning.AiAssistant
Summary
Functions
create_session/3
enabled?/0
endpoint_available?/0
get_session!/1
list_sessions_for_job/2
mark_disclaimer_read/1
put_expression_and_adaptor/3
query/2
save_message/3
title_max_length/0
update_message_status/3
user_has_read_disclaimer?/1
Lightning.AiAssistant.Limiter
Summary
Functions
validate_quota/1
Lightning.ApolloClient
Summary
Types
context/0
Functions
query/3
test/0
Lightning.Auditing
Summary
Functions
list_all/1
Lightning.Auditing.Audit
Summary
Callbacks
update_changes/1
Functions
event/7
save/2
Lightning.AuthProviders
Summary
Functions
build_handler/2
create/1
create_handler/1
delete!/1
get_authorize_url/1
get_existing/0
get_existing/1
get_handler/1
get_handlers/0
new/0
remove_handler/1
update/2
Lightning.AuthProviders.AuthConfig
Summary
Types
t/0
Lightning.AuthProviders.CacheWarmer
Summary
Functions
child_spec/1
execute/1
interval/0
Lightning.AuthProviders.Common
Summary
Functions
authorize_url/4
build_client/3
get_token/2
get_userinfo/3
get_wellknown/1
get_wellknown!/1
introspect/3
refresh_token/2
still_fresh/3
Lightning.AuthProviders.Common.TokenBody
Summary
Functions
from_oauth2_token/1
new/1
Lightning.AuthProviders.Google
Summary
Functions
provider_name/0
scopes/0
scopes_doc_url/0
wellknown_url/1
Lightning.AuthProviders.Handler
Summary
Types
opts/0
t/0
Functions
authorize_url/1
from_model/1
get_token/2
get_userinfo/2
new/2
Lightning.AuthProviders.OAuthBehaviour
Summary
Callbacks
authorize_url/4
build_client/1
get_token/3
get_userinfo/3
refresh_token/2
refresh_token/3
Lightning.AuthProviders.OauthHTTPClient
Summary
Types
option/0
Functions
delete/3
delete!/3
fetch_token/2
fetch_userinfo/2
generate_authorize_url/2
get/3
get!/3
head/3
head!/3
options/3
options!/3
patch/4
patch!/4
post/4
post!/4
put/4
put!/4
refresh_token/2
request/2
request!/2
revoke_token/2
still_fresh/3
trace/3
trace!/3
Lightning.AuthProviders.Salesforce
Summary
Functions
provider_name/0
scopes/0
scopes_doc_url/0
wellknown_url/1
Lightning.AuthProviders.Store
Summary
Types
finder/0
Functions
get_handler/2
get_handlers/0
put_handler/2
remove_handler/1
Lightning.AuthProviders.WellKnown
Summary
Types
body/0
headers/0
method/0
options/0
params/0
request/0
t/0
url/0
Functions
delete/3
delete!/3
fetch/1
fetch!/1
get/3
get!/3
head/3
head!/3
new/1
options/3
options!/3
patch/4
patch!/4
post/4
post!/4
process_headers/1
process_request_body/1
process_request_headers/1
process_request_options/1
process_request_params/1
process_request_url/1
process_response/1
process_response_body/1
process_response_chunk/1
process_response_headers/1
process_response_status_code/1
process_status_code/1
process_url/1
put/4
put!/4
request/1
request/5
request!/1
request!/5
start/0
stream_next/1
Lightning.BuildMacros
Summary
Functions
do_in/2
Lightning.CLI
Summary
Functions
execute/1
metadata/2
Lightning.CLI.Result
Sections
Logs
Summary
Types
t/0
Functions
get_messages/1
new/1
parse/2
Lightning.ChangesetUtils
Summary
Functions
put_if_provided/3
put_new_change/3
Lightning.Collections
Summary
Functions
create_collection/1
delete/2
delete_all/2
delete_collection/1
get/2
get_all/3
get_collection/1
list_collections/1
list_project_collections/1
put/3
put_all/2
update_collection/2
Lightning.Collections.Collection
Summary
Types
t/0
Functions
form_changeset/2
validate/1
Lightning.Collections.Item
Summary
Types
t/0
Lightning.DashboardStats
Summary
Functions
aggregate_project_metrics/1
filter_days_ago/2
get_workflow_stats/1
Lightning.DashboardStats.ProjectMetrics
Lightning.DashboardStats.WorkflowStats
Lightning.DataclipScrubber
Summary
Functions
scrub_dataclip_body!/1
Lightning.Demo
Summary
Functions
reset_demo/0
Lightning.ExportUtils
Summary
Functions
build_yaml_tree/2
generate_new_yaml/2
Lightning.Extensions.AccountHooking
Summary
Callbacks
handle_create_user/1
handle_register_superuser/1
handle_register_user/1
Lightning.Extensions.CollectionHook
Lightning.Extensions.CollectionHooking
Summary
Types
limit_error/0
Callbacks
handle_create/1
handle_delete/2
handle_delete_items/2
handle_put_items/2
Lightning.Extensions.FifoRunQueue
Lightning.Extensions.Message
Summary
Types
t/0
Lightning.Extensions.ProjectHook
Summary
Functions
handle_create_project/1
handle_delete_project/1
handle_project_validation/1
Lightning.Extensions.ProjectHooking
Summary
Callbacks
handle_create_project/1
handle_delete_project/1
handle_project_validation/1
Lightning.Extensions.RateLimiter
Lightning.Extensions.RateLimiting
Summary
Types
message/0
request_error/0
Callbacks
limit_request/3
Lightning.Extensions.RateLimiting.Context
Summary
Types
t/0
Lightning.Extensions.RunQueue
Summary
Callbacks
claim/1
dequeue/1
enqueue/1
enqueue_many/1
Lightning.Extensions.UsageLimiter
Lightning.Extensions.UsageLimiting
Summary
Types
error/0
error_reason/0
message/0
Callbacks
check_limits/1
get_data_retention_message/1
get_data_retention_periods/1
get_run_options/1
increment_ai_usage/2
limit_action/2
Lightning.FailureNotifierView
Summary
Functions
__resource__/0
failure_alert.html/1
render/2
template_not_found/2
Lightning.Graph
Summary
Types
t/0
Functions
add_edge/2
new/0
nodes/2
prune/2
remove_edges/2
traverse/2
Lightning.Helpers
Summary
Functions
actual_deletion_date/3
coerce_json_field/2
copy_error/4
format_date/2
format_date_long/1
json_safe/1
ms_to_human/1
url_safe_name/1
Lightning.Janitor
Summary
Functions
find_and_update_lost/0
perform/1
Lightning.KafkaTriggers
Summary
Functions
alternate_storage_file_name/2
build_topic_partition_offset/1
convert_rate_limit/0
enable_disable_triggers/1
failure_notification_tracking_key/1
find_enabled_triggers/0
generate_pipeline_child_spec/1
get_kafka_triggers_being_updated/1
initial_policy/1
maybe_write_to_alternate_storage/2
notify_users_of_trigger_failure/1
send_notification?/2
start_triggers/0
update_pipeline/2
Lightning.KafkaTriggers.DuplicateTrackingCleanupWorker
Lightning.KafkaTriggers.EventListener
Summary
Functions
child_spec/1
start_link/1
Lightning.KafkaTriggers.MessageHandling
Summary
Functions
convert_headers_for_serialisation/1
persist_message/3
Lightning.KafkaTriggers.MessageRecovery
Summary
Functions
build_broadway_message/2
extract_trigger_id/1
recover_messages/1
Lightning.KafkaTriggers.Pipeline
Summary
Functions
maybe_notify_users/2
start_link/1
Lightning.KafkaTriggers.PipelineSupervisor
Summary
Functions
child_spec/1
start_link/1
Lightning.KafkaTriggers.Supervisor
Summary
Functions
child_spec/1
start_link/1
Lightning.KafkaTriggers.TriggerKafkaMessageRecord
Summary
Functions
changeset/2
Lightning.MetadataService
Summary
Functions
fetch/2
Lightning.MetadataService.Error
Summary
Types
t/0
Functions
message/1
new/1
Lightning.Name
Summary
Functions
generate/1
Lightning.OauthClients
Summary
Functions
change_client/2
create_client/1
delete_client/1
get_client!/1
list_clients/1
update_client/2
Lightning.ObanManager
Summary
Functions
handle_event/4
Lightning.Policies.Collections
Summary
Types
actions/0
Functions
authorize/3
Lightning.Policies.Dataclips
Summary
Types
actions/0
Functions
authorize/3
Lightning.Policies.Exports
Summary
Types
actions/0
Functions
authorize/3
Lightning.Policies.Permissions
Summary
Functions
can/4
can?/4
Lightning.Policies.ProjectUsers
Summary
Types
actions/0
Functions
authorize/3
Lightning.Policies.Provisioning
Summary
Types
actions/0
Functions
authorize/3
Lightning.Policies.Users
Summary
Types
actions/0
Functions
authorize/3
Lightning.Policies.Workflows
Summary
Types
actions/0
Functions
authorize/3
Lightning.PromEx
Summary
Functions
child_spec/1
Lightning.Release
Summary
Functions
create_db/0
load_app/0
migrate/0
rollback/2
Lightning.Repo
Summary
Functions
aggregate/3
aggregate/4
all/2
checked_out?/0
checkout/2
child_spec/1
config/0
default_options/1
delete/2
delete!/2
delete_all/2
disconnect_all/2
exists?/2
explain/3
get/3
get!/3
get_by/3
get_by!/3
get_dynamic_repo/0
in_transaction?/0
insert/2
insert!/2
insert_all/3
insert_or_update/2
insert_or_update!/2
load/2
one/2
one!/2
paginate/2
preload/3
prepare_query/3
put_dynamic_repo/1
query/3
query!/3
query_many/3
query_many!/3
reload/2
reload!/2
rollback/1
scrivener_defaults/0
start_link/1
stop/1
stream/2
to_sql/2
transact/2
transaction/2
update/2
update!/2
update_all/3
Lightning.Run
Summary
Types
t/0
Functions
complete/2
final_states/0
for/2
new/1
start/2
Lightning.RunStep
Summary
Types
t/0
Functions
new/1
new/2
Lightning.SafetyString
Summary
Functions
decode/1
encode/1
Lightning.Schema
Lightning.Scrubber
Summary
Functions
add_samples/3
child_spec/1
encode_samples/2
samples/1
scrub/2
start_link/1
Lightning.Services.AccountHook
Summary
Functions
handle_create_user/1
handle_register_superuser/1
handle_register_user/1
Lightning.Services.AdapterHelper
Summary
Functions
adapter/1
Lightning.Services.CollectionHook
Lightning.Services.ProjectHook
Summary
Functions
handle_create_project/1
handle_delete_project/1
handle_project_validation/1
Lightning.Services.RateLimiter
Lightning.Services.RunQueue
Lightning.Services.UsageLimiter
Lightning.Setup
Summary
Functions
ensure_minimum_setup/0
setup_user/3
Lightning.SetupUtils
Summary
Functions
confirm_users/1
create_dhis2_project/1
create_openhie_project/1
create_starter_project/2
create_users/1
setup_demo/1
setup_user/3
tear_down/1
Lightning.SetupUtils.Ticker
Summary
Functions
child_spec/1
next/1
start_link/1
stop/1
Lightning.Storage
Lightning.Storage.Backend
Summary
Callbacks
get_url/1
store/2
Lightning.Storage.GCS
Sections
Responsibilities
Example Usage
Lightning.Storage.Local
Sections
Responsibilities
Example Usage
Lightning.Storage.ProjectFileDefinition
Summary
Functions
get_url/1
storage_path_for_exports/2
store/2
Lightning.TaskWorker
Summary
Functions
child_spec/1
get_status/1
start_link/1
start_task/2
Lightning.Tokens
Summary
Functions
get_subject/1
verify/1
Lightning.UsageTracking
Summary
Functions
disable_daily_report/0
enable_daily_report/1
enqueue_reports/3
find_enabled_daily_report_config/0
insert_report/3
lightning_version/0
reportable_dates/3
start_reporting_after/1
submit_report/2
update_report_submission!/2
Lightning.UsageTracking.Client
Summary
Functions
reachable?/1
submit_metrics/2
Lightning.UsageTracking.DailyReportConfiguration
Summary
Functions
changeset/2
Lightning.UsageTracking.DayWorker
Lightning.UsageTracking.GithubClient
Summary
Functions
build_client/1
open_fn_commit?/1
Lightning.UsageTracking.ProjectMetricsService
Summary
Functions
find_eligible_projects/1
generate_metrics/3
Lightning.UsageTracking.Report
Summary
Functions
changeset/2
Lightning.UsageTracking.ReportData
Summary
Functions
generate/3
Lightning.UsageTracking.ReportWorker
Lightning.UsageTracking.ResponseProcessor
Summary
Functions
successful?/1
successful_200?/1
Lightning.UsageTracking.ResubmissionCandidatesWorker
Lightning.UsageTracking.ResubmissionWorker
Lightning.UsageTracking.RunService
Summary
Functions
finished_steps/2
unique_job_ids/2
Lightning.UsageTracking.UserQueries
Summary
Functions
active_users/1
active_users/2
existing_users/1
existing_users/2
Lightning.UsageTracking.UserService
Summary
Functions
no_of_active_users/1
no_of_active_users/2
no_of_users/1
no_of_users/2
Lightning.UsageTracking.WorkflowMetricsQuery
Summary
Functions
runs_finished_on/2
workflow_runs/1
Lightning.UsageTracking.WorkflowMetricsService
Summary
Functions
find_eligible_workflows/2
generate_metrics/3
Lightning.Utils.Crypto
Summary
Functions
generate_hs256_key/0
generate_rsa_key_pair/0
Lightning.Validators
Summary
Functions
validate_exclusive/3
validate_one_required/3
validate_required_assoc/3
validate_url/2
Lightning.Vault
Summary
Functions
child_spec/1
start_link/1
Lightning.VersionControl
Summary
Functions
create_github_connection/2
delete_github_oauth_grant/1
exchange_code_for_oauth_token/1
fetch_installation_repos/1
fetch_repo_branches/2
fetch_user_access_token/1
fetch_user_installations/1
get_repo_connection_for_project/1
get_repo_connection_for_token/1
github_enabled?/0
initiate_sync/2
oauth_token_valid?/1
reconfigure_github_connection/3
refresh_oauth_token/1
remove_github_connection/2
save_oauth_token/3
subscribe/1
verify_github_connection/1
Lightning.VersionControl.Audit
Summary
Functions
base_query/0
event/5
repo_connection/3
save/1
update_changes/1
Lightning.VersionControl.GithubClient
Summary
Types
option/0
Functions
build_basic_auth_client/2
build_bearer_client/1
build_installation_client/1
build_oauth_client/0
create_blob/3
create_commit/3
create_ref/3
create_repo_dispatch_event/3
create_repo_secret/4
create_tree/3
create_workflow_dispatch_event/4
delete/3
delete!/3
delete_app_grant/3
delete_ref/3
delete_repo_content/4
delete_repo_secret/3
get/3
get!/3
get_commit/3
get_installation_repos/1
get_installations/1
get_repo/2
get_repo_branches/2
get_repo_content/4
get_repo_public_key/2
get_repo_secret/3
head/3
head!/3
options/3
options!/3
patch/4
patch!/4
post/4
post!/4
put/4
put!/4
request/2
request!/2
trace/3
trace!/3
update_ref/4
Lightning.VersionControl.GithubError
Summary
Types
t/0
Functions
api_error/2
file_not_found/2
installation_not_found/2
invalid_certificate/2
invalid_oauth_token/2
misconfigured/2
new/3
repo_secret_not_found/2
Lightning.VersionControl.GithubToken
Summary
Functions
build/2
generate_and_sign/2
generate_and_sign!/2
verify_and_validate/3
verify_and_validate!/3
Lightning.VersionControl.ProjectRepoConnection
Summary
Types
t/0
Functions
changeset/2
config_path/1
configure_changeset/2
create_changeset/2
reconfigure_changeset/2
Lightning.WebhookAuthMethods
Summary
Functions
create_auth_method/2
create_auth_method/3
create_changeset/2
delete_auth_method/1
find_by_api_key/2
find_by_id!/1
find_by_username_and_password/3
list_for_project/1
list_for_trigger/1
perform/1
schedule_for_deletion/2
update_auth_method/3
update_trigger_auth_methods/3
Lightning.WorkOrder
Summary
Types
t/0
Functions
validate/1
Lightning.Workers
Summary
Functions
generate_run_token/2
verify_run_token/2
verify_worker_token/2
Lightning.Workers.RunToken
Summary
Functions
generate_and_sign/2
generate_and_sign!/2
verify_and_validate/3
verify_and_validate!/3
Lightning.Workers.WorkerToken
Summary
Functions
generate_and_sign/2
generate_and_sign!/2
verify_and_validate/3
verify_and_validate!/3
Exceptions
React.CompileError
Other
mix lightning.download_adaptor_registry_cache
Summary
Functions
run/1
mix lightning.gen_encryption_key
mix lightning.gen_worker_keys
mix lightning.install_adaptor_icons
Summary
Types
option/0
Functions
get/3
get!/3
head/3
head!/3
options/3
options!/3
patch/4
patch!/4
request/2
request!/2
trace/3
trace!/3
mix lightning.install_runtime
Summary
Functions
packages/0
run/1
mix lightning.install_schemas
Summary
Types
body/0
headers/0
method/0
options/0
params/0
request/0
url/0
Functions
delete/3
delete!/3
fetch_schemas/2
get/3
get!/3
head/3
head!/3
options/3
options!/3
parse_excluded/1
patch/4
patch!/4
persist_schema/2
post/4
post!/4
process_headers/1
process_request_body/1
process_request_headers/1
process_request_options/1
process_request_params/1
process_request_url/1
process_response/1
process_response_body/1
process_response_chunk/1
process_response_headers/1
process_response_status_code/1
process_status_code/1
process_url/1
put/4
put!/4
request/1
request/5
request!/1
request!/5
run/1
start/0
stream_next/1
write_schema/3
Search documentation of Lightning
Settings
View Source
LightningWeb.DashboardLive.WelcomeSection
(Lightning v2.11.1)
×