Struct grafana_plugin_sdk::backend::DataSourceInstanceSettings

#[non_exhaustive]
pub struct DataSourceInstanceSettings {
    pub id: i64,
    pub uid: String,
    pub type_: String,
    pub name: String,
    pub url: String,
    pub user: String,
    pub database: String,
    pub basic_auth_enabled: bool,
    pub basic_auth_user: String,
    pub json_data: Value,
    pub decrypted_secure_json_data: HashMap<String, String>,
    pub updated: DateTime<Utc>,
}

Settings for a datasource instance.

A datasource is a datasource plugin of a certain type that has been configured and created in a Grafana organisation. For example, the ‘datasource’ may be the Prometheus datasource plugin, and there may be many configured Prometheus datasource instances configured in a Grafana organisation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: i64

The Grafana assigned numeric identifier of the the datasource instance.

uid: String

The Grafana assigned string identifier of the the datasource instance.

type_: String

The unique identifier of the plugin that the request is for.

This should be the same value as [PluginContext.plugin_id].

name: String

The configured name of the datasource instance.

url: String

The configured URL of a datasource instance (e.g. the URL of an API endpoint).

user: String

A configured user for a datasource instance. This is not a Grafana user, rather an arbitrary string.

database: String

The configured database for a datasource instance. (e.g. the default Database a SQL datasource would connect to).

basic_auth_enabled: bool

Indicates if this datasource instance should use basic authentication.

basic_auth_user: String

The configured user for basic authentication.

E.g. when a datasource uses basic authentication to connect to whatever API it fetches data from.

json_data: Value

The raw DataSourceConfig as JSON as stored by the Grafana server.

It repeats the properties in this object and includes custom properties.

decrypted_secure_json_data: HashMap<String, String>

Key-value pairs where the encrypted configuration in Grafana server have been decrypted before passing them to the plugin.

This data is not accessible to the Grafana frontend after it has been set, and should be used for any secrets (such as API keys or passwords).

updated: DateTime<Utc>

The last time the configuration for the datasource instance was updated.

Trait Implementations

impl Clone for DataSourceInstanceSettings

fn clone(&self) -> DataSourceInstanceSettings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DataSourceInstanceSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl TryFrom<(DataSourceInstanceSettings, String)> for DataSourceInstanceSettings

type Error = ConvertFromError

The type returned in the event of a conversion error.

fn try_from( (other, type_): (DataSourceInstanceSettings, String) ) -> Result<Self, Self::Error>

Performs the conversion.