readme, force datasource OR connection fields

Author: justinianvoss22

.chloggen/sqlqueryreceiver-break-up-datasource-into-struct.yaml

@@ -5,15 +5,15 @@ change_type: enhancement
 component: sqlqueryreceiver
 
 # A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
-note: Break up datasource into a struct with fields `host`, `port`, `database`, `username`, `password`, and `additional_params`.
+note: Add SQL connection fields `host`, `port`, `database`, `username`, `password`, and `additional_params`.
 
 # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
 issues: [39760]
 
 # (Optional) One or more lines of additional information to render under the primary note.
 # These lines will be padded with 2 spaces and then inserted directly into the document.
 # Use pipe (|) for multiline entries.
-subtext:
+subtext: These options can be used instead of the existing `datasource` configuration option.
 
 # If your change doesn't affect end users or the exported elements of any package,
 # you should instead start your pull request title with [chore] or use the "Skip Changelog" label.

internal/sqlquery/config.go

@@ -31,7 +31,29 @@ func (c Config) Validate() error {
 	if c.Driver == "" {
 		return errors.New("'driver' cannot be empty")
 	}
-	if c.DataSource == "" {
+
+	// If datasource is set, none of the individual connection parameters should be set
+	if c.DataSource != "" {
+		if c.Host != "" {
+			return errors.New("'host' cannot be set when 'datasource' is specified")
+		}
+		if c.Port != 0 {
+			return errors.New("'port' cannot be set when 'datasource' is specified")
+		}
+		if c.Database != "" {
+			return errors.New("'database' cannot be set when 'datasource' is specified")
+		}
+		if c.Username != "" {
+			return errors.New("'username' cannot be set when 'datasource' is specified")
+		}
+		if c.Password != "" {
+			return errors.New("'password' cannot be set when 'datasource' is specified")
+		}
+		if len(c.AdditionalParams) > 0 {
+			return errors.New("'additional_params' cannot be set when 'datasource' is specified")
+		}
+	} else {
+		// If datasource is not set, host, port, and database are required
 		if c.Host == "" {
 			return errors.New("'host' or 'datasource' must be specified")
 		}

receiver/sqlqueryreceiver/README.md

@@ -23,10 +23,10 @@ The SQL Query Receiver uses custom SQL queries to generate metrics from a databa
 
 ## Configuration
 
-The configuration supports the following top-level fields:
+**Connection Configuration (choose one approach):**
+
+**Option 1: Individual connection parameters** (cannot be used when `datasource` is set):
 
-- `driver`(required): The name of the database driver: one of _postgres_, _mysql_, _snowflake_, _sqlserver_, _hdb_ (SAP
-  HANA), _oracle_ (Oracle DB), _tds_ (SapASE/Sybase).
 - `host` (optional): The hostname or IP address of the database server.
   - For the `sqlserver` driver, an instance appended to the hostname (e.g. `hostname1/instance1`) will be parsed properly into this connection string: `sqlserver://username:password@host:port/instance`.
 - `port` (optional for `sqlserver`, otherwise required): The port number of the database server.
@@ -38,7 +38,10 @@ The configuration supports the following top-level fields:
   - The `password` field supports sensitive value handling through environment variables or other secure value sources. Special characters (such as #, @, %, etc.) are automatically URL-encoded to ensure proper connection string formatting.
   - For `mysql`: No URL encoding is applied
 - `additional_params` (optional): Additional driver-specific connection parameters.
-- `datasource`(optional): The datasource value passed to [sql.Open](https://pkg.go.dev/database/sql#Open). This value overrides the optional fields listed above and does not perform any special character escaping. This is a driver-specific string usually consisting of at least a database name and connection information. This is sometimes referred to as the "connection string" in driver documentation. Examples:
+
+**Option 2: Datasource string:**
+
+- `datasource`(optional): The datasource value passed to [sql.Open](https://pkg.go.dev/database/sql#Open). This value is used instead of the individual connection parameters listed above and does not perform any special character escaping. This is a driver-specific string usually consisting of at least a database name and connection information. This is sometimes referred to as the "connection string" in driver documentation. Examples:
 
   - [hdb](https://github.com/SAP/go-hdb) - `hdb://<USER>:<PASSWORD>@something.hanacloud.ondemand.com:443?TLSServerName=something.hanacloud.ondemand.com`
   - [mysql](https://github.com/go-sql-driver/mysql) - `username:user_password@tcp(localhost:3306)/db_name`
@@ -48,7 +51,10 @@ The configuration supports the following top-level fields:
   - [sqlserver](https://github.com/microsoft/go-mssqldb) - `sqlserver://username:user_password@localhost:1433?database=db_name`
   - [tds](https://github.com/thda/tds) - `tds://username:user_password@localhost:5000/db_name`
 
-- `queries`(required): A list of queries, where a query is a sql statement and one or more `logs` and/or `metrics` sections (details below).
+**Other configuration fields:**
+- `driver` (required): The name of the database driver: one of _postgres_, _mysql_, _snowflake_, _sqlserver_, _hdb_ (SAP
+  HANA), _oracle_ (Oracle DB), _tds_ (SapASE/Sybase).
+- `queries` (required): A list of queries, where a query is a sql statement and one or more `logs` and/or `metrics` sections (details below).
 - `collection_interval`(optional): The time interval between query executions. Defaults to _10s_.
 - `storage` (optional, default `""`): The ID of a [storage][storage_extension] extension to be used to [track processed results](#tracking-processed-results).
 - `telemetry` (optional) Defines settings for the component's own telemetry - logs, metrics or traces.