### start()

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/classhttp_1_1base_1_1Connection.html

Starts the connection, initiating any necessary setup.

```APIDOC
## start()

### Description
Starts the connection, initiating any necessary setup.

### Signature
```cpp
template<typename IOLayer >
void http::base::Connection< IOLayer >::start()
```

### Implements
http::base::ConnectionInterface

### Reimplemented in
http::client::Connection< IOLayer >
```

--------------------------------

### pfs_example_plugin_employee_init

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/pfs__example__plugin__employee_8cc.html

Initializes the pfs_example_plugin_employee plugin at server start or plugin installation.

```APIDOC
## pfs_example_plugin_employee_init()

### Description
Initializes the pfs_example_plugin_employee at server start or plugin installation.

### Parameters
- `p` (void *) - Pointer to plugin data.

### Return Value
- `int` - An integer representing the result of the initialization.
```

--------------------------------

### install_ng_with_start

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/xcom__base_8cc.html

Installs a new node group starting from a specified node.

```APIDOC
## install_ng_with_start()

### Description
Installs a new node group starting from a specified node.

### Parameters
- **_a_** (app_data_ptr) - Pointer to application data.
- **_start_** (synode_no) - The starting node number.

### Signature
`static site_def * install_ng_with_start(app_data_ptr _a_, synode_no _start_)
`
```

--------------------------------

### Initialize pfs_example_component_population

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/pfs__example__component__population_8cc.html

Initializes the pfs_example_component_population component at server start or component installation. This involves instantiating and initializing proxies, preparing rows, and adding tables to the Performance Schema.

```c
mysql_service_status_t pfs_example_component_population_init ()
```

--------------------------------

### Display setup.py Help

Source: https://dev.mysql.com/doc/dev/connector-python/latest/_sources/installation.rst.txt

To view all available options and commands for the setup.py script when installing from source, use this command.

```bash
shell> python setup.py --help
```

--------------------------------

### Get Start of Payload (Filesort_info)

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/sort__param_8h_source.html

A utility function to get the start of the payload using Filesort_info. It calls the static Sort_param::get_start_of_payload helper.

```cpp
inline uchar *get_start_of_payload(const Filesort_info *fsi, uchar *p) {
return Sort_param::get_start_of_payload(fsi->sort_length(),
 fsi->using_varlen_keys(), p);
}
```

--------------------------------

### Get Monitor Start Value

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/srv0mon_8h.html

Retrieves the start value of a monitor counter.

```c
#define MONITOR_START_VALUE | ( |  | monitor| ) |  MONITOR_FIELD(monitor, mon_start_value)
```

--------------------------------

### setup_windows1

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/window_8h_source.html

Initial setup for window functions, including requirement checks and preparation of execution structures.

```APIDOC
## setup_windows1

### Description
Performs initial setup for window functions, including checking requirements, preparing physical ordering lists, setting up cached items for partition and range determination, and checking frame semantics.

### Parameters
- **thd** (THD *) - The session's execution thread
- **select** (Query_block *) - The select block for which windowing is being performed
- **ref_item_array** (Ref_item_array) - The base reference items
- **tables** (Table_ref *) - The list of tables involved
- **fields** (mem_root_deque<Item *> *) - The list of all fields, including hidden ones
- **windows** (List<Window> *) - The list of windows defined for this select

### Returns
- **bool** - false if success, true if error
```

--------------------------------

### start_sandbox_instance

Source: https://dev.mysql.com/doc/dev/mysqlsh-api-python/latest/classmysqlsh_1_1dba_1_1_dba.html

Starts an existing MySQL Server instance on localhost.

```APIDOC
## start_sandbox_instance

### Description
Starts an existing MySQL Server instance on localhost.

### Signature
`None start_sandbox_instance(int port, dict options)`
```

--------------------------------

### Get Row Statement Start Timestamp

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/rpl__rli_8h_source.html

Retrieves the timestamp when a row statement started.

```cpp
time_t get_row_stmt_start_timestamp() { return row_stmt_start_timestamp; }
```

--------------------------------

### Get Event Start Position

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/rpl__rli_8h_source.html

Retrieves the starting position for an event in the relay log.

```cpp
my_off_t get_event_start_pos() { return event_start_pos; }
```

--------------------------------

### start()

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/classmysql__harness_1_1ProcessLauncher.html

Launches the child process and sets up pipes for I/O. Overloaded to support different handler configurations.

```APIDOC
## start()

### Description
Launches the child process and makes pipes available for read/write.

### Overloads
1. `void start(bool _use_std_io_handlers = false)`
2. `void start(bool _use_stdout_handler, bool _use_stdin_handler)`
```

--------------------------------

### ft_init_ext_with_hints

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/sql_2handler_8h_source.html

Initializes a full-text search index using hints for configuration.

```APIDOC
## ft_init_ext_with_hints

### Description
Initializes a full-text search (FT) index using provided hints for configuration. This method leverages `ft_init_ext` with flags derived from the hints.

### Method
virtual FT_INFO *ft_init_ext_with_hints(uint inx, String *key, Ft_hints *hints)

### Parameters
- **inx** (uint) - The index to initialize.
- **key** (String *) - The key associated with the full-text search.
- **hints** (Ft_hints *) - A structure containing hints for the initialization.

### Returns
- **FT_INFO *** - A pointer to FT_INFO structure containing initialization details, or nullptr on failure.
```

--------------------------------

### ICU Data Directory (Install)

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/globals_g.html

Gets the ICU data directory path used during installation.

```APIDOC
## get_icu_data_directory_in_install_dir()

### Description
Returns the path to the International Components for Unicode (ICU) data directory as configured during installation.

### Method
Function Call

### Endpoint
N/A (Internal function)

### Parameters
None

### Request Example
```
get_icu_data_directory_in_install_dir()
```

### Response
- **path** (string) - The path to the ICU data directory.
```

--------------------------------

### run(mysql_harness::PluginFuncEnv *env)

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/classserver__mock_1_1MySQLServerMock-members.html

Starts the MySQL mock server and begins processing requests using the provided plugin environment.

```APIDOC
## run(mysql_harness::PluginFuncEnv *env)

### Description
Starts the MySQL mock server and processes requests.

### Method
public

### Parameters
- **env** (mysql_harness::PluginFuncEnv *) - The plugin function environment.
```

--------------------------------

### Get Query Start Time in Seconds

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/sql__class_8h_source.html

Returns the query start time as seconds since the epoch.

```c++
time_t query_start_in_secs() const { return start_time.tv_sec; }
```

--------------------------------

### Time and Setup Actor Management

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/group__performance__schema__buffers.html

Functions for getting system time and managing setup actor buffers.

```APIDOC
## gtid_monitoring_getsystime

### Description
Get current time for GTID monitoring.

### Signature
ulonglong gtid_monitoring_getsystime ()

```

```APIDOC
## init_setup_actor

### Description
Initialize the setup actor buffers.

### Signature
int init_setup_actor (const PFS_global_param *param)

```

```APIDOC
## cleanup_setup_actor

### Description
Cleanup all the setup actor buffers.

### Signature
void cleanup_setup_actor ()

```

--------------------------------

### Example: Implementing a Query Event Consumer

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/event__tracking__query__consumer__helper_8h_source.html

This example demonstrates how to set up a query event consumer. It shows how to include the necessary header, define filtered sub-events, implement a callback function, and declare the component and its services.

```cpp
#include "mysql/components/util/event_tracking_query_consumer_helper.h"

namespace Event_tracking_implementation {

// Replace following with union of subevents to be filtered
mysql_event_tracking_query_subclass_t
Event_tracking_query_implementation::filtered_sub_events = 0;

bool Event_tracking_query_implementation::callback(
const mysql_event_tracking_query_data *data [[maybe_unused]]) {
// Your code goes here
}
} // namespace Event_tracking_implementation

// Define init/deinit methods for component

// Component declaration related stuff

IMPLEMENTS_SERVICE_EVENT_TRACKING_QUERY(<implementation_name>);

BEGIN_COMPONENT_PROVIDES(<component_name>)
PROVIDES_SERVICE_EVENT_TRACKING_QUERY(<implementation_name>)
END_COMPONENT_PROVIDES()

// Rest of the component declaration code

```

--------------------------------

### rec_get_start

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/rem0rec_8ic.html

Gets the starting position of a record.

```APIDOC
## ◆ rec_get_start()

| static byte * rec_get_start  | ( | const rec_t *  | _rec_ ,   const ulint *  | _offsets_  
) |

### Parameters
- **rec** (const rec_t *) - 
- **offsets** (const ulint *) - 

### Returns
- byte *
```

--------------------------------

### startSandboxInstance

Source: https://dev.mysql.com/doc/dev/mysqlsh-api-javascript/latest/classmysqlsh_1_1dba_1_1_dba.html

Starts an existing MySQL Server instance on localhost.

```APIDOC
## startSandboxInstance

### Description
Starts an existing MySQL Server instance on localhost.

### Signature
Undefined startSandboxInstance (Integer port, Dictionary options)

### Parameters
* **port** (Integer) - The port of the sandbox instance to start.
* **options** (Dictionary) - Options for starting the sandbox instance.
```

--------------------------------

### get_sweep_start

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/xcom__base_8cc.html

Gets the starting synode number for the sweep.

```APIDOC
## get_sweep_start()

### Description
Gets the starting synode number for the sweep.

### Signature
`static synode_no get_sweep_start()
`
```

--------------------------------

### setup

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/namespacecomponents_1_1log__builtins__component__helper.html

Initializes the log builtins component helper.

```APIDOC
## setup()

### Description
Sets up the log builtins component helper.

### Function Signature
`void components::log_builtins_component_helper::setup()`
```

--------------------------------

### startSandboxInstance()

Source: https://dev.mysql.com/doc/dev/mysqlsh-api-javascript/latest/classmysqlsh_1_1dba_1_1_dba.html

Starts an existing MySQL Server instance on localhost. It can take a port number and an optional dictionary of options, including the sandbox directory.

```APIDOC
## startSandboxInstance()

### Description
Starts an existing MySQL Server instance on localhost.

### Parameters
- **port** (Integer) - The port where the instance listens for MySQL connections.
- **options** (Dictionary) - Optional dictionary with options affecting the result. 
  - **sandboxDir** (string) - Path where the instance is located. If not specified, it defaults to `~/mysql-sandboxes` on Unix-like systems or `%userprofile%\MySQL\mysql-sandboxes` on Windows systems.

### Returns
Nothing.
```

--------------------------------

### mem_block_get_start

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/mem0mem_8ic.html

Gets the start offset of a memory block.

```APIDOC
## mem_block_get_start

### Description
Gets the start offset of a memory block.

### Signature
ulint mem_block_get_start(mem_block_t *block)

### Remarks
This is an inlinestatic function.
```

--------------------------------

### start

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/classmysql__harness_1_1Loader.html

Initializes and starts all loaded plugins.

```APIDOC
## start ()

### Description
Initialize and start all loaded plugins.
```

--------------------------------

### Get Monitor Value Since Start

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/srv0mon_8h.html

Calculates and retrieves the monitor value since the counter was started, accounting for reset values.

```c
#define MONITOR_VALUE_SINCE_START | ( |  | monitor| ) |  (MONITOR_VALUE(monitor) + MONITOR_VALUE_RESET(monitor))
```

--------------------------------

### start_sandbox_instance()

Source: https://dev.mysql.com/doc/dev/mysqlsh-api-python/latest/functions_s.html

Starts a sandbox MySQL instance.

```APIDOC
## start_sandbox_instance() : Dba

### Description
Starts a sandbox MySQL instance.

### Usage
- Dba: Manages sandbox instances.
```

--------------------------------

### page_align

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/structlob_1_1ref__t.html

Gets the start of the page containing this blob reference.

```APIDOC
## page_align () const

### Description
Gets the start of a page containing this blob reference.

### Returns
* **page_t *** - A pointer to the start of the aligned page.
```

--------------------------------

### my_b_get_buffer_start

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/group__MYSYS.html

Gets the starting address of the IO cache buffer.

```APIDOC
## ◆ my_b_get_buffer_start()
| uchar * my_b_get_buffer_start  | ( | const IO_CACHE *  | _info_| ) | 
inline
```

--------------------------------

### Usage Lines Output Example

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/classCmdArgHandler.html

Example output for command line usage, showing options, their names, and optional/required values.

```text
usage: mysqlrouter [-v|--version] [-h|--help] [-c|--config=<path>]
                   [-a=[<foo>]] [rest..]

```

--------------------------------

### Get Record Start Pointer (Debug)

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/rem0rec_8h_source.html

In debug builds, returns a pointer to the start of the record. Requires the record pointer and the offsets array.

```cpp
#ifdef UNIV_DEBUG
[[nodiscard]] static inline byte *rec_get_start(const rec_t *rec,
                                  const ulint *offsets);
#else /* UNIV_DEBUG */
#define rec_get_start(rec, offsets) ((rec)-rec_offs_extra_size(offsets))
#endif /* UNIV_DEBUG */

```

--------------------------------

### set_up_default_partitions()

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/classpartition__info.html

Sets up default partitions based on provided information.

```APIDOC
## set_up_default_partitions()

### Signature
`bool partition_info::set_up_default_partitions(Partition_handler * _part_handler_, HA_CREATE_INFO * _info_, uint _start_no_)`

### Description
Configures the default partitions for a table using the provided partition handler, creation information, and a starting number. This is crucial for establishing the initial partitioning scheme.
```

--------------------------------

### get_last_applier_start_micros

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/applier__metrics__interface_8h_source.html

Gets the timestamp (in microseconds) when the applier's metric timer was last started. This can be used to calculate durations relative to the start time.

```APIDOC
## get_last_applier_start_micros

### Description
Gets the time point when the metric timer started.

### Signature
virtual int64_t get_last_applier_start_micros() const =0
```

--------------------------------

### start

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/classmysql__harness_1_1Loader.html

Initializes and starts all loaded plugins in the correct order. Plugins with a 'start' callback will be initiated.

```APIDOC
## ◆ start()
```cpp
void Loader::start()
```
### Description
Initialize and start all loaded plugins. All registered plugins will be initialized in proper order and started (if they have a `start` callback).

### Exceptions
* **first** (std::exception_ptr) - Exception that was triggered by an error returned from any plugin function.
```

--------------------------------

### LogReopenComponent Initialization Example

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/log__reopen__component_8h_source.html

Initializes the LogReopenComponent after all plugins have started. This ensures that the logging registry is fully set up before the log reopen thread is started.

```cpp
loader->after_all_started([](){
LogReopenComponent::get_instance().init();
});
```

--------------------------------

### example_init

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/example__component1_8cc.html

Initialization entry method for the example_component1. This function is called when the component is loaded.

```APIDOC
## ◆ example_init()
mysql_service_status_t example_init  | ( | | ) | 
---|---|---|---|---
This file contains a definition of the example_component1. 
Initialization entry method for Component used when loading the Component. 

Returns
    Status of performed operation  

Return values
     0| success   
non-zero| failure   
```

--------------------------------

### Basic_binlog_file_reader::event_start_pos

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/binlog__reader_8h_source.html

Gets the starting position of the last read event.

```APIDOC
## Basic_binlog_file_reader::event_start_pos

### Description
Returns the starting position in the binlog file of the most recently read event.

### Method
my_off_t event_start_pos()

### Parameters
None

### Return Value
The starting position of the last event as a `my_off_t` value.
```

--------------------------------

### handler::ft_init_ext_with_hints

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/sql_2handler_8h_source.html

Initializes extended full-text search functionality with specific hints.

```APIDOC
## ft_init_ext_with_hints

### Description
Initializes extended full-text search functionality with hints.

### Signature
`virtual FT_INFO * ft_init_ext_with_hints(uint inx, String *key, Ft_hints *hints)`
```

--------------------------------

### Example: Implementing a Connection Event Consumer

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/event__tracking__connection__consumer__helper_8h_source.html

This example demonstrates how to set up a component to consume connection events. It shows how to filter sub-events and define a callback function.

```cpp
#include "mysql/components/util/event_tracking_connection_consumer_helper.h"

namespace Event_tracking_implementation {

// Replace following with union of subevents to be filtered
mysql_event_tracking_connection_subclass_t
Event_tracking_connection_implementation::filtered_sub_events = 0;

bool Event_tracking_connection_implementation::callback(
const mysql_event_tracking_connection_data *data [[maybe_unused]]) {
// Your code goes here
}
} // namespace Event_tracking_implementation

// Define init/deinit methods for component

// Component declaration related stuff

IMPLEMENTS_SERVICE_EVENT_TRACKING_CONNECTION(<implementation_name>);

BEGIN_COMPONENT_PROVIDES(<component_name>)
PROVIDES_SERVICE_EVENT_TRACKING_CONNECTION(<implementation_name>)
END_COMPONENT_PROVIDES()

// Rest of the component declaration code

```

--------------------------------

### Create Client from Options

Source: https://dev.mysql.com/doc/dev/connector-cpp/latest/classmysqlx_1_1abi2_1_1r0_1_1Client.html

Instantiate a Client object by providing connection parameters as separate arguments. This is a convenient way to specify host, port, user, password, and database.

```cpp
Client from_options("host", port, "user", "pwd", "db");
```

--------------------------------

### test_server_telemetry_logs_component_init

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/test__server__telemetry__logs__client_2server__logs__component_8cc.html

Initializes the test_server_telemetry_logs component at server start or component installation.

```APIDOC
## test_server_telemetry_logs_component_init()

### Description
Initialize the test_server_telemetry_logs component at server start or component installation.
```

--------------------------------

### startSandboxInstance()

Source: https://dev.mysql.com/doc/dev/mysqlsh-api-javascript/latest/functions_s.html

Starts a sandboxed MySQL instance.

```APIDOC
## startSandboxInstance()

### Description
Initiates and starts a temporary, isolated MySQL instance for testing or development purposes.

### Usage
- Dba: Manages sandbox instances.
```

--------------------------------

### Create a Client with Connection Pooling

Source: https://dev.mysql.com/doc/dev/connector-nodejs/latest/module-mysqlx.html

This example demonstrates how to create a client instance with connection pooling enabled. It configures the maximum number of connections and then retrieves a session.

```javascript
const client = mysqlx.getClient({ user: 'root' }, { pooling: { enabled: true, maxSize: 3 } })

client.getSession()
  .then(session => {
    console.log(session.inspect()); // { host: 'localhost', port: 33060, user: 'root', pooling: true, ... }
  })
```

--------------------------------

### MySQL Router Log Output Example

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/PAGE_MYSQL_SERVER_MOCK.html

Example log output from a running MySQL Router, showing started routing instances and metadata cache connections.

```log
2017-01-24 12:28:30 INFO    [7fc57d7eb700] [routing:test_default_ro] started: listening on 0.0.0.0:6447; read-only
2017-01-24 12:28:30 INFO    [7fc57dfec700] Starting Metadata Cache
2017-01-24 12:28:30 INFO    [7fc57cfea700] [routing:test_default_rw] started: listening on 0.0.0.0:6446; read-write
2017-01-24 12:28:30 INFO    [7fc577fff700] [routing:test_default_x_rw] started: listening on 0.0.0.0:64460; read-write
2017-01-24 12:28:30 INFO    [7fc5747e9700] [routing:test_default_x_ro] started: listening on 0.0.0.0:64470; read-only
2017-01-24 12:28:30 INFO    [7fc57dfec700] Connected with metadata server running on 127.0.0.1:5500
2017-01-24 12:28:30 INFO    [7fc57dfec700] Changes detected in cluster 'test' after metadata refresh
2017-01-24 12:28:30 INFO    [7fc57dfec700] Metadata for cluster 'test' has 1 replicasets:
2017-01-24 12:28:30 INFO    [7fc57dfec700] 'default' (3 members, single-primary)
2017-01-24 12:28:30 INFO    [7fc57dfec700]     localhost:5100 / 50000 - role=HA mode=RW
2017-01-24 12:28:30 INFO    [7fc57dfec700]     localhost:5110 / 50100 - role=HA mode=RO
2017-01-24 12:28:30 INFO    [7fc57dfec700]     localhost:5120 / 50200 - role=HA mode=RO
2017-01-24 12:28:30 INFO    [7fc5757fa700] Connected with metadata server running on 127.0.0.1:5500

```

--------------------------------

### rec_2_get_field_start_offs_low

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/rem0lrec_8h_source.html

Gets the starting offset of the nth field in 2-byte offset format.

```APIDOC
## rec_2_get_field_start_offs_low

### Description
Returns the offset of the start of the nth field if the record is stored in the 2-byte offsets form.

### Parameters
- **rec** (const rec_t *) - The record.
- **n** (ulint) - The index of the field.

### Returns
- The offset of the start of the field.
```

--------------------------------

### Create REST Service Example

Source: https://dev.mysql.com/doc/dev/mysql-rest-service/latest/sql.html

An example demonstrating how to create a simple REST service named '/myService'. The `COMMENT` option is used for description.

```sql
CREATE OR REPLACE REST SERVICE /myService
    COMMENT "A simple REST service";
```

--------------------------------

### start()

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/classmrs_1_1database_1_1SchemaMonitor.html

Starts the schema monitoring process.

```APIDOC
## start()

void mrs::database::SchemaMonitor::start ()

### Description
Initiates the schema monitoring service. This typically involves starting background threads or processes to watch for schema changes.
```

--------------------------------

### page_align()

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/page0page_8h.html

Gets the start of a page by aligning a given pointer to the page boundary.

```APIDOC
## page_align()

### Description
Gets the start of a page.

### Method
static page_t * page_align(const void * _ptr_)

### Parameters
- **ptr** (const void *) - in: pointer to page frame

### Returns
start of the page
```

--------------------------------

### pfs_example_init

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/pfs__example_8cc.html

Initializes the pfs_example component. Returns a status code indicating success or failure.

```APIDOC
## pfs_example_init()

### Description
Initializes the pfs_example component.

### Method
static mysql_service_status_t pfs_example_init ()

### Return Value
- `mysql_service_status_t`: Status of the initialization.
```

--------------------------------

### Basic_binlog_file_reader::event_start_pos

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/binlog__reader_8h_source.html

Gets the starting position of the current event in the binlog file.

```APIDOC
## Basic_binlog_file_reader::event_start_pos

### Description
Gets the starting position of the current event in the binlog file.

### Signature
my_off_t event_start_pos()

### Returns
The starting position of the current event.
```

--------------------------------

### Create REST Service with Options Example

Source: https://dev.mysql.com/doc/dev/mysql-rest-service/latest/sql.html

Illustrates creating a REST service with detailed configuration, including comments, authentication path, and extensive JSON options for headers, HTTP settings, and logging.

```sql
CREATE OR REPLACE REST SERVICE /myTestService
    COMMENTS "A simple REST service"
    AUTHENTICATION
        PATH "/authentication"
        REDIRECTION DEFAULT
        VALIDATION DEFAULT
        PAGE CONTENT DEFAULT
    OPTIONS {
        "headers": {
            "Access-Control-Allow-Credentials": "true",
            "Access-Control-Allow-Headers": "Content-Type, Authorization, X-Requested-With, Origin, X-Auth-Token",
            "Access-Control-Allow-Methods": "GET, POST, PUT, DELETE, OPTIONS"
        },
        "http": {
            "allowedOrigin": "auto"
        },
        "logging": {
            "exceptions": true,
            "request": {
                "body": true,
                "headers": true
            },
            "response": {
                "body": true,
                "headers": true
            }
        },
        "returnInternalErrorDetails": true,
        "includeLinksInResults": false
    };
```

--------------------------------

### Get Minimum Monitor Value Since Start

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/srv0mon_8h_source.html

A macro to retrieve the minimum value a monitor counter has held since it was started. Useful for tracking performance lows.

```c
#define MONITOR_MIN_VALUE_START(monitor)
```

--------------------------------

### Example: Implementing a Command Event Consumer

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/event__tracking__command__consumer__helper_8h_source.html

This example demonstrates how to set up a component to consume command events. It shows how to filter sub-events and define a callback function to handle incoming event data. Ensure you replace placeholder names like <implementation_name> and <component_name> with your specific identifiers.

```cpp
#include "mysql/components/util/event_tracking_command_consumer_helper.h"

namespace Event_tracking_implementation {

// Replace following with union of subevents to be filtered
mysql_event_tracking_command_subclass_t
Event_tracking_command_implementation::filtered_sub_events = 0;

bool Event_tracking_command_implementation::callback(
const mysql_event_tracking_command_data *data [[maybe_unused]]) {
// Your code goes here
}
} // namespace Event_tracking_implementation

// Define init/deinit methods for component

// Component declaration related stuff

IMPLEMENTS_SERVICE_EVENT_TRACKING_COMMAND(<implementation_name>);

BEGIN_COMPONENT_PROVIDES(<component_name>)
PROVIDES_SERVICE_EVENT_TRACKING_COMMAND(<implementation_name>)
END_COMPONENT_PROVIDES()

// Rest of the component declaration code

```

--------------------------------

### Get Start of Payload (Sort_param)

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/sort__param_8h_source.html

Retrieves the starting address of the payload within a sorted record. It accounts for variable-length keys and fixed lengths based on the Sort_param configuration.

```cpp
uchar *get_start_of_payload(uchar *p) const {
  size_t offset = using_varlen_keys() ? uint4korr(p) : max_compare_length();
  if (!using_addon_fields() && !using_varlen_keys())
  offset -= sum_ref_length; // The reference is also part of the sort key.
  return p + offset;
}
```

--------------------------------

### setup_table()

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/classacl__table_1_1Acl__table__user__reader.html

Prepares the mysql.user table for reading.

```APIDOC
## bool setup_table(bool &is_old_db_layout)

### Description
Make table ready to read.

### Parameters
- **is_old_db_layout** (bool &) - Output parameter indicating if the database layout is old.
```

--------------------------------

### Const_boundary_view Iterator Interface

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/boundary__set__const__views_8h_source.html

Defines the iterator for `Const_boundary_view`, enabling iteration over compile-time defined boundaries. Use `begin()` to get an iterator to the start and `end()` to get an iterator to the end.

```cpp
using Iterator_t = 
detail::Const_boundary_view_iterator<Set_traits_tp, boundaries...>;
using Const_iterator_t = Iterator_t;

/// @return Iterator to the beginning.
[[nodiscard]] auto begin() const { return Iterator_t(); }

/// @return Iterator to the end.
[[nodiscard]] auto end() const { return Iterator_t(Iterator_t::size); }
```

--------------------------------

### start_sandbox_instance()

Source: https://dev.mysql.com/doc/dev/mysqlsh-api-python/latest/classmysqlsh_1_1dba_1_1_dba.html

Starts an existing MySQL Server instance on localhost. It requires the port number and can optionally take a dictionary of options, including the sandbox directory.

```APIDOC
## start_sandbox_instance(port: int, options: dict)

### Description
Starts an existing MySQL Server instance on localhost.

### Parameters
- **port** (int) - The port where the instance listens for MySQL connections.
- **options** (dict) - Optional dictionary with options affecting the result. Supported keys include 'sandboxDir'.

### Returns
Nothing.

### Example
```python
dba.start_sandbox_instance(3306, {"sandboxDir": "/path/to/sandbox"})
```
```

--------------------------------

### Get Start LSN UDF

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/backup__page__tracker_8h_source.html

User Defined Function to retrieve the start Log Sequence Number (LSN). It returns a long long value and indicates null/error status.

```c++
static long long page_track_get_start_lsn(UDF_INIT *initid, UDF_ARGS *,
 unsigned char *is_null,
 unsigned char *error);
```

--------------------------------

### start_pos

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/rpl__injector_8h_source.html

Gets the position for the start of the transaction. This is the 'tail of Binlog' position when the transaction began.

```APIDOC
## binlog_pos start_pos() const

### Description
Gets the binlog position at the start of the transaction.

### Return Value
- binlog_pos: The starting binlog position.
```

--------------------------------

### offset()

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/classtemptable_1_1Chunk.html

Gets the Chunk offset relative to the start of its belonging Block. This method is const.

```APIDOC
## offset()

### Description
Get the Chunk offset relative to the start of belonging Block.

### Returns
Offset relative to the start of belonging Block.
```

--------------------------------

### PFS_index_setup_meters Constructor

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/classPFS__index__setup__meters.html

Initializes a new instance of the PFS_index_setup_meters class with a given PFS_engine_key.

```APIDOC
## PFS_index_setup_meters()

### Description
Constructs a PFS_index_setup_meters object.

### Parameters
* **_key_1** (PFS_engine_key *) - The engine key to associate with this index setup.
```

--------------------------------

### temptable::Chunk::offset

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/chunk_8h_source.html

Get the Chunk offset relative to the start of belonging Block.

```APIDOC
## Chunk::offset

### Description
Get the Chunk offset relative to the start of belonging Block.

### Signature
`size_t Chunk::offset() const`
```

--------------------------------

### install_default_setup

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/pfs__defaults_8cc.html

Configures the performance schema setup tables with default content. The tables populated are: SETUP_ACTORS, SETUP_OBJECTS.

```APIDOC
## install_default_setup()

### Description
Configure the performance schema setup tables with default content.

### Parameters
* `thread_boot` (PSI_thread_bootstrap *) - A pointer to the thread bootstrap structure.
```

--------------------------------

### Standalone Comment Block Example

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/coding__guidelines_8h_source.html

Provides an example of a standalone comment block. Comments should be in English, start with a capital letter, and end sentences with a period. Lines should not exceed 79 characters.

```c
/*
This is a standalone comment. The comment is aligned to fit 79
characters per line. There is a period at the end of each sentence.
Including the last one.
*/
```

--------------------------------

### start()

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/classhttp_1_1base_1_1Connection.html

Starts the connection, initiating network activity and event handling.

```APIDOC
## start()

| void | start ()
override
```

--------------------------------

### Starting and Managing Async Tasks

Source: https://dev.mysql.com/doc/dev/mysql-rest-service/latest/sdk.html

This example shows how to start an asynchronous task, monitor its progress, and handle specific statuses like TIMEOUT or COMPLETED. It also demonstrates how to cancel a task.

```APIDOC
## Starting and Managing Async Tasks

This example shows how to start an asynchronous task, monitor its progress, and handle specific statuses like TIMEOUT or COMPLETED. It also demonstrates how to cancel a task.

### Method
`start()`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* `pInventoryId` (number) - Required - Example parameter for the inventory ID.

#### Options Object
* `timeout` (number) - Optional - The maximum time in milliseconds to wait for the task to complete. If exceeded, the task is killed.

### Request Example
```typescript
const task = myService.sakila.inventoryInStock.start({ pInventoryId: 1 }, { timeout: 10000 });

for await (const report of task.watch()) {
  if (report.status === "TIMEOUT") {
    await task.kill();
  } else if (report.status === "CANCELLED") {
    console.log(report.message);
  } else if (report.status === "COMPLETED") {
    console.log(report.data.result);
  }
}
```

### Response
#### Success Response
A `Task` object is returned, which provides methods to `watch()` for status updates and `kill()` the task.

#### Response Example
(The `task.watch()` method yields report objects with `status`, `message`, and `data` fields.)
```

--------------------------------

### PFS_index_setup_instruments Constructor

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/classPFS__index__setup__instruments.html

Initializes a new instance of the PFS_index_setup_instruments class.

```APIDOC
## PFS_index_setup_instruments()

### Description
Constructs an object of the PFS_index_setup_instruments class.

### Method
`PFS_index_setup_instruments::PFS_index_setup_instruments()`

### Parameters
None
```

--------------------------------

### Get start offset of nth field (low-level)

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/rem0lrec_8h_source.html

Retrieves the starting byte offset of the nth field within the record. It accounts for whether the record uses 1-byte or 2-byte offsets.

```c
static inline ulint rec_get_field_start_offs_low(const rec_t *rec, ulint n) {
 ut_ad(rec);
 ut_ad(n <= rec_get_n_fields_old_raw(rec));

 if (n == 0) {
 return (0);
 }

 if (rec_get_1byte_offs_flag(rec)) {
 return (rec_1_get_field_start_offs_low(rec, n));
 }

 return (rec_2_get_field_start_offs_low(rec, n));
}
```

--------------------------------

### pfs_example_component_population_init

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/pfs__example__component__population_8cc.html

Initializes the pfs_example_component_population at server start or component installation. It instantiates and initializes PFS_engine_table_share_proxy, prepares and inserts rows in tables, and calls the add_table method of the pfs_plugin_table_v1 service. Returns 0 on success, non-zero on failure.

```APIDOC
## pfs_example_component_population_init()

### Description
Initialize the pfs_example_component_population at server start or component installation. More...

### Return values
     0| success   
   non-zero| failure   

### Details
  * Instantiate and initialize PFS_engine_table_share_proxy.
  * Prepare and insert rows in tables from here.
  * Call add_table method of pfs_plugin_table_v1 service.

Call add_table function of pfs_plugin_table_v1 service to add component tables in performance schema.
```

--------------------------------

### Example Services Header

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/dir_749f65ee8b141ed006f28cae26f3198d.html

Header file defining example services.

```cpp
#include "mysql/components/service_interface.h"

namespace mysql {
namespace components {

// Example service interface.
class ExampleService : public ServiceInterface {
 public:
  ExampleService() = default;
  ~ExampleService() override = default;

  // Example method.
  virtual int Process(int value) = 0;
};

}  // namespace components
}  // namespace mysql

```

--------------------------------

### Get Start Position of Match

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/regexp__engine_8h_source.html

Returns the starting index of the most recent match found in the subject string. This function is used after a successful Matches() call to determine where the matched text begins.

```c++
int StartOfMatch() {
  /*
  The 0 is for capture group number, but we don't deal with those
  here. Zero means the start of the whole match, which is what's needed.
  */
  return uregex_start(m_re, 0, &m_error_code);
}
```

--------------------------------

### ha_example::info Implementation

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/ha__example_8cc.html

This function is required to provide information about the storage engine.

```cpp
int info(uint) override
required
```

--------------------------------

### Page Alignment and Offset Functions

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/page0page_8h.html

Functions to get the start of a page and the offset within a page.

```APIDOC
## page_align

### Description
Gets the start of a page.

### Signature
`static page_t * page_align (const void *ptr)`
```

```APIDOC
## page_offset

### Description
Gets the offset within a page.

### Signature
`static ulint page_offset (const void *ptr)`
```

--------------------------------

### startSandboxInstance()

Source: https://dev.mysql.com/doc/dev/mysqlsh-api-javascript/latest/functions_func_s.html

Starts a sandbox instance. Used in Dba.

```APIDOC
## startSandboxInstance()

### Description
Initiates and starts a temporary sandbox database instance.

### Contexts
- Dba
```

--------------------------------

### page_align

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/page0page_8ic.html

Gets the start of a page. This function is used to retrieve the base address of a page frame.

```APIDOC
## page_align()

### Description
Gets the start of a page.

### Parameters
- **_ptr_** (const void *) - in: pointer to page frame

### Returns
start of the page
```

--------------------------------

### Kill a long-running task

Source: https://dev.mysql.com/doc/dev/mysql-rest-service/latest/sdk.html

Example demonstrating how to start a task and then kill it if it exceeds a specified timeout.

```APIDOC
## Kill a long-running task

### Description
This example shows how to initiate a potentially long-running operation using the SDK and then conditionally terminate it if it takes too long to complete. It utilizes the `start` method to initiate the task and `kill` to stop it if a timeout occurs.

### Method
```javascript
await myService.mrsNotes.noteUpdate.start({ noteId: note.id, title: "hello world" }, { timeout: 10000 })
await task.kill()
```

### Parameters
* `noteId` (string) - The ID of the note to update.
* `title` (string) - The new title for the note.
* `timeout` (number) - The maximum time in milliseconds to allow the task to run before timing out.
```

--------------------------------

### set_start_and_boot

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/xcom__base_8cc.html

Initiates the start and boot process with new configuration.

```APIDOC
## set_start_and_boot()

static void set_start_and_boot(site_def * _new_config_, app_data_ptr _a_)
```

--------------------------------

### Install Connector/Python from Source on Unix-Like Systems

Source: https://dev.mysql.com/doc/dev/connector-python/latest/_sources/installation.rst.txt

Commands to install Connector/Python from a tar archive on Unix-like systems. This includes extracting the archive, navigating to the directory, and running the setup script with Protobuf-related options.

```bash
shell> tar xzf mysqlx-connector-python-<version>.tar.gz
   shell> cd mysqlx-connector-python-<version>.tar.gz
   shell> python setup.py install --with-protobuf-include-dir=<protobuf-include-dir> --with-protobuf-lib-dir=<protobuf-lib-dir> --with-protoc=<protoc-binary>
```

--------------------------------

### PFS_index_setup_metrics Constructor

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/classPFS__index__setup__metrics.html

Initializes a new instance of the PFS_index_setup_metrics class with a given PFS_engine_key.

```APIDOC
## PFS_index_setup_metrics(PFS_engine_key *key_1)

### Description
Constructs a PFS_index_setup_metrics object.

### Parameters
* **key_1** (PFS_engine_key *) - The engine key to associate with this index setup.
```

--------------------------------

### get_packed_ptr() - Get Packed Pointer Address

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/spatial_8cc.html

Gets the starting address of a polygon's WKB string. The polygon is assumed to be already packed, with its rings pointing to different locations of a continuous WKB buffer.

```APIDOC
## get_packed_ptr()

### Description
Get a polygon's WKB string's starting address. The polygon is already packed so that its outer ring and inner rings point to different locations of a continuous chunk of WKB buffer.

### Parameters
- **geo0** (Geometry *) - The already packed polygon, we want to get its data address.

### Returns
The WKB string starting address, right after the WKB header if any.
```

--------------------------------

### page_get_supremum_offset

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/page0page_8ic.html

Gets the offset of the last record within the record list on the page, relative to the start of the page.

```APIDOC
## page_get_supremum_offset()

### Description
Gets the offset of the last record on the page.

### Parameters
- **page** (const page_t *): in: page which must have record(s)
```

--------------------------------

### Create Session from Options

Source: https://dev.mysql.com/doc/dev/connector-cpp/latest/classmysqlx_1_1abi2_1_1r0_1_1Session.html

Create a session by directly specifying host, port, user, password, and database.

```cpp
Session from_options("host", port, "user", "pwd", "db");
```

--------------------------------

### setup_key_functions

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/mi__open_8cc.html

Sets up key functions for key information.

```APIDOC
## setup_key_functions()

### Description
Configures and sets up key functions based on provided key information.

### Signature
`static void setup_key_functions(MI_KEYDEF *_keyinfo_)
`
```

--------------------------------

### MetadataLogger Control

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/metadata__logger_8h_source.html

Functions to start and stop the metadata logger, along with a method to get the singleton instance.

```APIDOC
## start

### Description
Starts the metadata logger with the provided configuration and cache manager.

### Signature
`void start(const mrs::Configuration *configuration, collector::MysqlCacheManager *cache);`

## stop

### Description
Stops the metadata logger.

## instance

### Description
Returns the singleton instance of the MetadataLogger.

### Signature
`static MetadataLogger &instance();`
```

--------------------------------

### Get Start of Payload (Static Helper)

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/sort__param_8h_source.html

A static helper function to determine the start of the payload, used when Sort_param is not directly accessible. It uses a default value for fixed-size keys and reads the offset for variable-length keys.

```cpp
static uchar *get_start_of_payload(uint default_val, bool is_varlen,
 uchar *p) {
  const size_t offset = is_varlen ? uint4korr(p) : default_val;
  return p + offset;
}
```

--------------------------------

### Comprehensive DUMP REST PROJECT Example

Source: https://dev.mysql.com/doc/dev/mysql-rest-service/latest/sql.html

A detailed example demonstrating various options for dumping a REST service, including multiple services, specific SQL files for schemas, and project settings like icon and publisher.

```sql
DUMP REST PROJECT 'myProject' VERSION '1.0.0'
    SERVICE /myService INCLUDING DATABASE AND STATIC AND DYNAMIC ENDPOINTS
    SERVICE /myService2 INCLUDING ALL ENDPOINTS
    DATABASE `chatApp` FROM '~/mrs_plugin/examples/mrs_chat/db_schema/chat_db_schema.sql'
    DATABASE `chatRestService` FROM '~/mrs_plugin/examples/mrs_chat/db_schema/chat_rest_service.sql'
    DATABASE `chatApp2` FROM '~/mrs_plugin/examples/mrs_chat/db_schema/'
    DATABASE `sakila`
    DESCRIPTION 'This is my first project'
    PUBLISHER 'Oracle'
    ICON FROM '~/icon.svg'
    TO ZIP '~/project.myService.zip';
```

--------------------------------

### Get start offset of nth field (1-byte offsets, low-level)

Source: https://dev.mysql.com/doc/dev/mysql-server/latest/rem0lrec_8h_source.html

Specifically retrieves the starting byte offset for the nth field when the record uses 1-byte offsets. Asserts that 1-byte offsets are indeed in use.

```c
static inline ulint rec_1_get_field_start_offs_low(const rec_t *rec, ulint n) {
 ut_ad(rec_get_1byte_offs_flag(rec));
 ut_ad(n <= rec_get_n_fields_old_raw(rec));

 if (n == 0) {
 return (0);
 }

 return (rec_1_get_prev_field_end_info(rec, n) & ~REC_1BYTE_SQL_NULL_MASK);
}
```