Skip to content

Commit 9f6cf40

Browse files
committed
#104 - Polishing.
Fix documentation links. Use variables for links to Spring Framework reference docs. Original pull request: #127.
1 parent 043e8a6 commit 9f6cf40

File tree

7 files changed

+15
-13
lines changed

7 files changed

+15
-13
lines changed

src/main/asciidoc/index.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
ifdef::backend-epub3[:front-cover-image: image:epub-cover.png[Front Cover,1050,1600]]
66
:spring-data-commons-docs: ../../../../spring-data-commons/src/main/asciidoc
77
:spring-data-r2dbc-javadoc: https://docs.spring.io/spring-data/r2dbc/docs/{version}/api
8+
:spring-framework-ref: https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference
89
:reactiveStreamsJavadoc: https://www.reactive-streams.org/reactive-streams-{reactiveStreamsVersion}-javadoc
910

1011
(C) 2018-2019 The original authors.

src/main/asciidoc/preface.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ This section provides some basic introduction to Spring and databases.
1111
[[get-started:first-steps:spring]]
1212
== Learning Spring
1313

14-
Spring Data uses Spring framework's https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html[core] functionality, including:
14+
Spring Data uses Spring framework's {spring-framework-ref}/core.html[core] functionality, including:
1515

16-
* https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html#beans[IoC] container
17-
* https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html#validation[type conversion system]
18-
* https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html#expressions[expression language]
19-
* https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/integration.html#jmx[JMX integration]
20-
* https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/data-access.html#dao-exceptions[DAO exception hierarchy].
16+
* {spring-framework-ref}/core.html#beans[IoC] container
17+
* {spring-framework-ref}/core.html#validation[type conversion system]
18+
* {spring-framework-ref}/core.html#expressions[expression language]
19+
* {spring-framework-ref}/integration.html#jmx[JMX integration]
20+
* {spring-framework-ref}/data-access.html#dao-exceptions[DAO exception hierarchy].
2121

2222
While you need not know the Spring APIs, understanding the concepts behind them is important.
2323
At a minimum, the idea behind Inversion of Control (IoC) should be familiar, and you should be familiar with whatever IoC container you choose to use.

src/main/asciidoc/reference/r2dbc-core.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ public class ApplicationConfiguration extends AbstractR2dbcConfiguration {
219219
----
220220
====
221221

222-
This approach lets you use the standard `io.r2dbc.spi.ConnectionFactory` instance, with the container using Spring's `AbstractR2dbcConfiguration`. As compared to registering a `ConnectionFactory` instance directly, the configuration support has the added advantage of also providing the container with an `ExceptionTranslator` implementation that translates R2DBC exceptions to exceptions in Spring's portable `DataAccessException` hierarchy for data access classes annotated with the `@Repository` annotation. This hierarchy and the use of `@Repository` is described in https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/data-access.html[Spring's DAO support features].
222+
This approach lets you use the standard `io.r2dbc.spi.ConnectionFactory` instance, with the container using Spring's `AbstractR2dbcConfiguration`. As compared to registering a `ConnectionFactory` instance directly, the configuration support has the added advantage of also providing the container with an `ExceptionTranslator` implementation that translates R2DBC exceptions to exceptions in Spring's portable `DataAccessException` hierarchy for data access classes annotated with the `@Repository` annotation. This hierarchy and the use of `@Repository` is described in {spring-framework-ref}/data-access.html[Spring's DAO support features].
223223

224224
`AbstractR2dbcConfiguration` registers also `DatabaseClient` that is required for database interaction and for Repository implementation.
225225

src/main/asciidoc/reference/r2dbc-transactions.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ A common pattern when using relational databases is grouping multiple queries wi
55
Relational databases typically associate a transaction with a single transport connection.
66
Using different connections hence results in utilizing different transactions.
77
Spring Data R2DBC includes transaction-awareness in `DatabaseClient` that allows you to group multiple statements within
8-
the same transaction using https://docs.spring.io/spring/docs/current/spring-framework-reference/data-access.html#transaction[Spring's Transaction Management].
8+
the same transaction using {spring-framework-ref}/data-access.html#transaction[Spring's Transaction Management].
99
Spring Data R2DBC provides a implementation for `ReactiveTransactionManager` with `R2dbcTransactionManager`.
1010
See <<r2dbc.connections.R2dbcTransactionManager>> for further details.
1111

@@ -35,7 +35,7 @@ Mono<Void> atomicOperation = client.sql("INSERT INTO person (id, name, age) VALU
3535
<2> Bind the operation to the `TransactionalOperator`.
3636
====
3737

38-
https://docs.spring.io/spring/docs/current/spring-framework-reference/data-access.html#transaction-declarative[Spring's declarative Transaction Management]
38+
{spring-framework-ref}/data-access.html#transaction-declarative[Spring's declarative Transaction Management]
3939
is a less invasive, annotation-based approach to transaction demarcation.
4040

4141
.Declarative Transaction Management

src/main/java/org/springframework/data/r2dbc/convert/ColumnMapRowMapper.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@
2727
import org.springframework.util.LinkedCaseInsensitiveMap;
2828

2929
/**
30-
* {@link RowMapper} implementation that creates a {@link Map} for each row, representing all columns as key-value
31-
* pairs: one entry for each column, with the column name as key.
30+
* {@link BiFunction Mapping function} implementation that creates a {@link Map} for each row, representing all columns
31+
* as key-value pairs: one entry for each column, with the column name as key.
3232
* <p>
3333
* The {@link Map} implementation to use and the key to use for each column in the column Map can be customized through
3434
* overriding {@link #createColumnMap} and {@link #getColumnKey}, respectively.

src/main/java/org/springframework/data/r2dbc/core/TransactionalDatabaseClient.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@
3333
* transaction. Alternatively, transactions can be started and cleaned up using {@link #beginTransaction()} and
3434
* {@link #commitTransaction()}.
3535
* <p>
36-
* Transactional resources are bound to {@link ReactiveTransactionSynchronization} through nested
36+
* Transactional resources are bound to
37+
* {@link org.springframework.data.r2dbc.connectionfactory.ReactiveTransactionSynchronization} through nested
3738
* {@link TransactionContext} enabling nested (parallel) transactions. The simplemost approach to use transactions is by
3839
* using {@link #inTransaction(Function)} which will start a transaction and commit it on successful termination. The
3940
* callback allows execution of multiple statements within the same transaction.

src/main/java/org/springframework/data/r2dbc/dialect/BindMarker.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ public interface BindMarker {
2424
* Bind the given {@code value} to the {@link Statement} using the underlying binding strategy.
2525
*
2626
* @param bindTarget the target to bind the value to.
27-
* @param value the actual value. Must not be {@literal null}. Use {@link #bindNull(Statement, Class)} for
27+
* @param value the actual value. Must not be {@literal null}. Use {@link #bindNull(BindTarget, Class)} for
2828
* {@literal null} values.
2929
* @see Statement#bind
3030
*/

0 commit comments

Comments
 (0)