Skip to content

Commit

Permalink
add startup-jobs documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
falvarez1 committed May 23, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 8cf8411 commit 64947bf
Showing 3 changed files with 77 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/features/minimal-api.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Minimal API
# Minimal API

The minimal job API offers another way of defining a cron job. It favors simplicity over feature richness. A job can be defined as such:

```csharp
@@ -64,7 +65,7 @@ builder.Services.AddNCronJob([RetryPolicy(retryCount: 3)] (JobExecutionContext c
}, "0 * * * *");
```

## Concurrency-Support
## Concurrency-Support
In the same way, the concurrency level can be controlled (see [**Concurrency**](concurrency-control.md)):

```csharp
@@ -73,7 +74,7 @@ builder.Services.AddNCronJob([SupportsConcurrency(2)] () => { }, "0 * * * *");

Now, the job can only be executed by two instances at the same time.

## Restrictions
## Restrictions

The minimal API has some restrictions over the "full approach":

72 changes: 72 additions & 0 deletions docs/features/startup-jobs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Running Startup Jobs

**NCronJob** allows you to configure jobs to run at application startup. This is useful for tasks that need to be executed immediately when the application starts, such as initial data loading, cleanup tasks, or other setup procedures.

Startup jobs are defined like regular CRON jobs and inherit from `IJob`. The only difference is that they are configured to run at startup.

```csharp
public class MyStartupJob : IJob
{
public Task RunAsync(JobExecutionContext context, CancellationToken token)
{
// Perform startup task
return Task.CompletedTask;
}
}

```

As with CRON jobs, they must be registered in the `AddNCronJob` method.

```csharp
Services.AddNCronJob(options =>
{
options.AddJob<MyStartupJob>()
.RunAtStartup(); // Configure the job to run at startup
});
```

The `RunAtStartup` method ensures that the job is executed as soon as the application starts. This method is useful for scenarios where certain tasks need to be performed immediately upon application launch.

## Example Use Case

Consider an application that needs to load initial data from a database or perform some cleanup tasks whenever it starts. You can define and configure a startup job to handle this:

### Job Definition
```csharp
public class InitialDataLoader : IJob
{
private readonly IDataService _dataService;

public InitialDataLoader(IDataService dataService)
{
_dataService = dataService;
}

public async Task RunAsync(JobExecutionContext context, CancellationToken token)
{
await _dataService.LoadInitialDataAsync();
}
}
```

### Registering the Job

In your `Program.cs` or `Startup.cs` file, register the job and configure it to run at startup:

```csharp
builder.Services.AddNCronJob(options =>
{
options.AddJob<InitialDataLoader>()
.RunAtStartup();
});
```

This setup ensures that the `InitialDataLoader` job will be executed as soon as the application starts, loading the necessary initial data.


## Summary

Startup jobs are a powerful feature of **NCronJob** that enable you to execute critical tasks immediately upon application startup. By using the `RunAtStartup` method, you can ensure that your application performs necessary setup procedures, data loading, or cleanup tasks right at the beginning of its lifecycle.

This feature is particularly useful for applications that require certain operations to be completed before they are fully functional. By configuring startup jobs, you can streamline your application's initialization process and improve its overall reliability and performance.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -37,6 +37,7 @@ nav:
- Concurrency control: features/concurrency-control.md
- Retry support: features/retry-support.md
- Minimal API: features/minimal-api.md
- Startup Jobs: features/startup-jobs.md
- Migration:
- v2 Migration Guide: migration/v2.md
- Advanced:

0 comments on commit 64947bf

Please sign in to comment.