RpcRequest (Reactive Relational Database Connectivity - Microsoft SQL Server 1.0.2.RELEASE API)

java.lang.Object
- io.r2dbc.mssql.message.token.RpcRequest

All Implemented Interfaces:

io.r2dbc.mssql.message.ClientMessage, io.r2dbc.mssql.message.Message, TokenStream
```
public final class RpcRequest
extends Object
implements io.r2dbc.mssql.message.ClientMessage, TokenStream
```
RPC request to invoke stored procedures.

Author:

Mark Paluch

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RpcRequest.Builder
Builder for RpcRequest.

static class RpcRequest.OptionFlags
RPC option flags.

Nested Classes
Modifier and Type	Class and Description
`static class`	`RpcRequest.Builder` Builder for `RpcRequest`.
`static class`	`RpcRequest.OptionFlags` RPC option flags.

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`Sp_Cursor` Requests positioned updates.
`static short`	`Sp_CursorClose` Closes and de-allocates the cursor, as well as releases all associated resources; that is, it drops the temporary table used in support of KEYSET or STATIC cursor.
`static short`	`Sp_CursorExecute` Creates and populates a cursor based upon the execution plan created by `Sp_CursorPrepare`.
`static short`	`Sp_CursorFetch` Fetches a buffer of one or more rows from the database.
`static short`	`Sp_CursorOpen` Opens a cursor.
`static short`	`Sp_CursorOption` Sets cursor options or returns cursor information created by the `Sp_CursorOpen` stored procedure.
`static short`	`Sp_CursorPrepare` Compiles the cursor statement or batch into an execution plan, but does not create the cursor.
`static short`	`Sp_CursorPrepExec` Compiles a plan for the submitted cursor statement or batch, then creates and populates the cursor.
`static short`	`Sp_CursorUnprepare` Discards the execution plan developed in the sp_cursorprepare stored procedure.
`static short`	`Sp_Execute` Executes a prepared Transact-SQL statement using a specified handle and optional parameter value.
`static short`	`Sp_ExecuteSql` Executes a Transact-SQL statement or batch that can be reused many times, or one that has been built dynamically.
`static short`	`Sp_Prepare` Prepares a parameterized Transact-SQL statement and returns a statement handle for execution.
`static short`	`Sp_PrepExec` Prepares and executes a parameterized Transact-SQL statement.
`static short`	`Sp_PrepExecRpc` Prepares and executes a parameterized stored procedure call that has been specified using an RPC identifier.
`static short`	`Sp_Unprepare` Discards the execution plan created by the sp_prepare stored procedure.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RpcRequest.Builder`	`builder()` Creates a new `RpcRequest.Builder` to build a `RpcRequest`.
`org.reactivestreams.Publisher<TdsFragment>`	`encode(io.netty.buffer.ByteBufAllocator allocator, int packetSize)` Encode a message into a `data buffer`.
`boolean`	`equals(Object o)`
`String`	`getName()`
`Integer`	`getProcId()`
`String`	`getProcName()`
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - Sp_Cursor
```
public static final short Sp_Cursor
```
    Requests positioned updates. This procedure performs operations on one or more rows within a cursor's fetch buffer.
    
    See Also:
    
    Constant Field Values
  - Sp_CursorOpen
```
public static final short Sp_CursorOpen
```
    Opens a cursor. sp_cursoropen defines the SQL statement associated with the cursor and cursor options, and then populates the cursor.
    
    See Also:
    
    Constant Field Values
  - Sp_CursorPrepare
```
public static final short Sp_CursorPrepare
```
    Compiles the cursor statement or batch into an execution plan, but does not create the cursor. The compiled statement can later be used by Sp_CursorExecute.
    
    See Also:
    
    Constant Field Values
  - Sp_CursorExecute
```
public static final short Sp_CursorExecute
```
    Creates and populates a cursor based upon the execution plan created by Sp_CursorPrepare. This procedure, coupled with Sp_CursorPrepare, has the same function as Sp_CursorOpen, but is split into two phases.
    
    See Also:
    
    Constant Field Values
  - Sp_CursorPrepExec
```
public static final short Sp_CursorPrepExec
```
    Compiles a plan for the submitted cursor statement or batch, then creates and populates the cursor. sp_cursorprepexec combines the functions of Sp_CursorPrepare and Sp_CursorExecute.
    
    See Also:
    
    Constant Field Values
  - Sp_CursorUnprepare
```
public static final short Sp_CursorUnprepare
```
    Discards the execution plan developed in the sp_cursorprepare stored procedure.
    
    See Also:
    
    Constant Field Values
  - Sp_CursorFetch
```
public static final short Sp_CursorFetch
```
    Fetches a buffer of one or more rows from the database. The group of rows in this buffer is called the cursor's fetch buffer.
    
    See Also:
    
    Constant Field Values
  - Sp_CursorOption
```
public static final short Sp_CursorOption
```
    Sets cursor options or returns cursor information created by the Sp_CursorOpen stored procedure.
    
    See Also:
    
    Constant Field Values
  - Sp_CursorClose
```
public static final short Sp_CursorClose
```
    Closes and de-allocates the cursor, as well as releases all associated resources; that is, it drops the temporary table used in support of KEYSET or STATIC cursor.
    
    See Also:
    
    Constant Field Values
  - Sp_ExecuteSql
```
public static final short Sp_ExecuteSql
```
    Executes a Transact-SQL statement or batch that can be reused many times, or one that has been built dynamically.
    
    See Also:
    
    Constant Field Values
  - Sp_Prepare
```
public static final short Sp_Prepare
```
    Prepares a parameterized Transact-SQL statement and returns a statement handle for execution.
    
    See Also:
    
    Constant Field Values
  - Sp_Execute
```
public static final short Sp_Execute
```
    Executes a prepared Transact-SQL statement using a specified handle and optional parameter value.
    
    See Also:
    
    Constant Field Values
  - Sp_PrepExec
```
public static final short Sp_PrepExec
```
    Prepares and executes a parameterized Transact-SQL statement. Sp_PrepExec combines the functions of Sp_Prepare and Sp_Execute.
    
    See Also:
    
    Constant Field Values
  - Sp_PrepExecRpc
```
public static final short Sp_PrepExecRpc
```
    Prepares and executes a parameterized stored procedure call that has been specified using an RPC identifier.
    
    See Also:
    
    Constant Field Values
  - Sp_Unprepare
```
public static final short Sp_Unprepare
```
    Discards the execution plan created by the sp_prepare stored procedure.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - builder
```
public static RpcRequest.Builder builder()
```
    Creates a new RpcRequest.Builder to build a RpcRequest.
    
    Returns:
    
    a new RpcRequest.Builder to build a RpcRequest.
  - encode
```
public org.reactivestreams.Publisher<TdsFragment> encode(io.netty.buffer.ByteBufAllocator allocator,
                                                         int packetSize)
```
    Description copied from interface: io.r2dbc.mssql.message.ClientMessage
    
    Encode a message into a data buffer. Can encode either to a scalar TdsFragment or a Publisher of TdsFragment.
    
    Specified by:
    
    encode in interface io.r2dbc.mssql.message.ClientMessage
    
    Parameters:
    
    allocator - the ByteBufAllocator to use to get a data buffer to write into.
    
    packetSize - packet size hint.
    
    Returns:
    
    a scalar TdsFragment or a Publisher that produces the TdsFragment containing the encoded message.
  - getProcName
```
@Nullable
public String getProcName()
```
  - getProcId
```
public Integer getProcId()
```
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface TokenStream
    
    Returns:
    
    symbolic name of the TokenStream.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RpcRequest

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

Sp_Cursor

Sp_CursorOpen

Sp_CursorPrepare

Sp_CursorExecute

Sp_CursorPrepExec

Sp_CursorUnprepare

Sp_CursorFetch

Sp_CursorOption

Sp_CursorClose

Sp_ExecuteSql

Sp_Prepare

Sp_Execute

Sp_PrepExec

Sp_PrepExecRpc

Sp_Unprepare

Method Detail

builder

encode

getProcName

getProcId

getName

equals

hashCode

toString