Skip to content

Commit 3069f38

Browse files
committed
Docs updated to reflect 3.0.x boot and task
1 parent 3b91404 commit 3069f38

File tree

5 files changed

+19
-14
lines changed

5 files changed

+19
-14
lines changed

docs/src/main/asciidoc/appendix-task-repository-schema.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ Stores the task execution information.
2020
|TASK_EXECUTION_ID |TRUE |BIGINT | X |
2121
Spring Cloud Task Framework at app startup establishes the next available id as obtained from the `TASK_SEQ`. Or if the record is created outside of task then the value must be populated at record creation time.
2222

23-
|START_TIME |FALSE | DATETIME | X | Spring Cloud Task Framework at app startup establishes the value.
23+
|START_TIME |FALSE | DATETIME(6) | X | Spring Cloud Task Framework at app startup establishes the value.
2424

25-
|END_TIME |FALSE | DATETIME | X | Spring Cloud Task Framework at app exit establishes the value.
25+
|END_TIME |FALSE | DATETIME(6) | X | Spring Cloud Task Framework at app exit establishes the value.
2626

2727
|TASK_NAME |FALSE | VARCHAR | 100 | Spring Cloud Task Framework at app startup will set this to "Application" unless user establish the name using the `spring.application.name`.
2828

@@ -32,7 +32,7 @@ Spring Cloud Task Framework at app startup establishes the next available id as
3232

3333
|ERROR_MESSAGE |FALSE | VARCHAR | 2500 | Spring Cloud Task Framework at app exit establishes the value.
3434

35-
|LAST_UPDATED |TRUE | DATETIME | X | Spring Cloud Task Framework at app startup establishes the value. Or if the record is created outside of task then the value must be populated at record creation time.
35+
|LAST_UPDATED |TRUE | TIMESTAMP | X | Spring Cloud Task Framework at app startup establishes the value. Or if the record is created outside of task then the value must be populated at record creation time.
3636

3737
|EXTERNAL_EXECUTION_ID |FALSE | VARCHAR | 250 | If the `spring.cloud.task.external-execution-id` property is set then Spring Cloud Task Framework at app startup will set this to the value specified. More information can be found <<features-external_task_id,here>>
3838

docs/src/main/asciidoc/batch-starter.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ You can read from a queue or topic with AMQP by using the `AmqpItemReader`. The
9292
autoconfiguration for this `ItemReader` implementation is dependent upon two sets of
9393
configuration. The first is the configuration of an `AmqpTemplate`. You can either
9494
configure this yourself or use the autoconfiguration provided by Spring Boot. See the
95-
https://docs.spring.io/spring-boot/docs/2.4.x/reference/htmlsingle/#boot-features-amqp[Spring Boot AMQP documentation].
95+
https://docs.spring.io/spring-boot/docs/3.0.x/reference/htmlsingle/#messaging.amqp.rabbitmq[Spring Boot AMQP documentation].
9696
Once you have configured the `AmqpTemplate`, you can enable the batch capabilities to support it
9797
by setting the following properties:
9898

@@ -412,7 +412,8 @@ covers how to use autoconfiguration to configure a supported `ItemWriter`.
412412

413413
To write to a RabbitMQ queue, you need two sets of configuration. First, you need an
414414
`AmqpTemplate`. The easiest way to get this is by using Spring Boot's
415-
RabbitMQ autoconfiguration. See the https://docs.spring.io/spring-boot/docs/2.4.x/reference/htmlsingle/#boot-features-amqp[Spring Boot RabbitMQ documentation].
415+
RabbitMQ autoconfiguration. See the https://docs.spring.io/spring-boot/docs/3.0.x/reference/htmlsingle/#messaging.amqp.rabbitmq[Spring Boot AMQP documentation].
416+
416417
Once you have configured the `AmqpTemplate`, you can configure the `AmqpItemWriter` by setting the
417418
following properties:
418419

docs/src/main/asciidoc/features.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,7 @@ To do so, add the process-aot execution and set `spring.cloud.task.single-step-i
399399

400400
To Enable Task Observations for `ApplicationRunner` or `CommandLineRunner` set `spring.cloud.task.observation.enabled` to true.
401401

402-
An example task application with observations enables using the `SimpleMeterRegistry` can be found https://github.com/spring-cloud/spring-cloud-task/tree/main/spring-cloud-task-samples/task-metrics[here].
402+
An example task application with observations enables using the `SimpleMeterRegistry` can be found https://github.com/spring-cloud/spring-cloud-task/tree/main/spring-cloud-task-samples/task-observations[here].
403403

404404
=== Disabling Spring Cloud Task Auto Configuration
405405

docs/src/main/asciidoc/getting-started.adoc

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ discussing some core principles as we go.
1414
== Introducing Spring Cloud Task
1515

1616
Spring Cloud Task makes it easy to create short-lived microservices. It provides
17-
capabilities that let short lived JVM processes be executed on demand in a production
17+
capabilities that let short-lived JVM processes be executed on demand in a production
1818
environment.
1919

2020
[[getting-started-system-requirements]]
2121
== System Requirements
2222

23-
You need to have Java installed (Java 8 or better). To build, you need to have Maven
23+
You need to have Java installed (Java 17 or better). To build, you need to have Maven
2424
installed as well.
2525

2626
=== Database Requirements
@@ -72,31 +72,35 @@ To do so:
7272
To finish our application, we need to update the generated `HelloworldApplication` with the following contents so that it launches a Task.
7373
[source,java]
7474
----
75-
package io.spring.demo.helloworld;
75+
package io.spring.Helloworld;
7676
77+
import org.springframework.boot.ApplicationArguments;
78+
import org.springframework.boot.ApplicationRunner;
7779
import org.springframework.boot.CommandLineRunner;
7880
import org.springframework.boot.SpringApplication;
7981
import org.springframework.boot.autoconfigure.SpringBootApplication;
82+
import org.springframework.cloud.task.configuration.EnableTask;
8083
import org.springframework.context.annotation.Bean;
8184
8285
@SpringBootApplication
8386
@EnableTask
8487
public class HelloworldApplication {
8588
8689
@Bean
87-
public CommandLineRunner commandLineRunner() {
88-
return new HelloWorldCommandLineRunner();
90+
public ApplicationRunner applicationRunner() {
91+
return new HelloWorldApplicationRunner();
8992
}
9093
9194
public static void main(String[] args) {
9295
SpringApplication.run(HelloworldApplication.class, args);
9396
}
9497
95-
public static class HelloWorldCommandLineRunner implements CommandLineRunner {
98+
public static class HelloWorldApplicationRunner implements ApplicationRunner {
9699
97100
@Override
98-
public void run(String... strings) throws Exception {
101+
public void run(ApplicationArguments args) throws Exception {
99102
System.out.println("Hello, World!");
103+
100104
}
101105
}
102106
}
@@ -147,7 +151,7 @@ The main method serves as the entry point to any java application. Our main met
147151
delegates to Spring Boot's https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-spring-application.html[SpringApplication] class.
148152

149153
[[getting-started-clr]]
150-
==== The CommandLineRunner
154+
==== The ApplicationRunner
151155

152156
Spring includes many ways to bootstrap an application's logic. Spring Boot provides
153157
a convenient method of doing so in an organized manner through its `*Runner` interfaces
-4.22 KB
Loading

0 commit comments

Comments
 (0)