Install MySQL user-defined functions

This document describes how to install a predefined library of MySQL functionsin a Spanner database. You can add these functions to yourdatabase using the Google Cloud console or the Google Cloud CLI.

Installing these MySQL functions extends Spanner's capabilities,allowing you to perform operations that are common in MySQL environmentsdirectly within Spanner.

For more information about the MySQL functions that Spannersupports, seeMySQL functions.

Required roles

To get the permissions that you need to install the MySQL functions, ask your administrator to grant you theCloud Spanner Database Admin (roles/spanner.databaseAdmin) IAM role on your project. For more information about granting roles, seeManage access to projects, folders, and organizations.

You might also be able to get the required permissions throughcustom roles or otherpredefined roles.

Install the MySQL user-defined functions

You can install the MySQL user-defined functions in a Spannerdatabase in the following ways:

Google Cloud console

  1. In the Google Cloud console, go to the SpannerInstances page.

    Go to the Instances page

  2. Click the instance containing the database.

  3. Click the database.

  4. Click theWrite DDL button to open Spanner Studio.

  5. Copy the entire content of the DDL file in themysql_udfs.sqlfile.

  6. In a SQL editor tab, paste the copied content from the DDL file,

  7. ClickRun.

gcloud

You can use thegcloud spanner database ddl updatecommand to install the MySQL UDFs.

Before using any of the command data below, make the following replacements:

  • DATABASE_ID: the ID of the database to add the MySQL UDFs.
  • INSTANCE_ID: the ID of the instance where the database is located.
  • DDL_FILE_PATH: path to a file containing all theCREATE OR REPLACE FUNCTION statements in themysql_udfs.sql file.

Execute the following command:

Linux, macOS, or Cloud Shell

Note: Ensure you have initialized the Google Cloud CLI with authentication and a project by running eithergcloud init; orgcloud auth login andgcloud config set project.
gcloudspannerdatabasesddlupdateDATABASE_ID\--instance=INSTANCE_ID\--ddl-file=DDL_FILE_PATH

Windows (PowerShell)

Note: Ensure you have initialized the Google Cloud CLI with authentication and a project by running eithergcloud init; orgcloud auth login andgcloud config set project.
gcloudspannerdatabasesddlupdateDATABASE_ID`--instance=INSTANCE_ID`--ddl-file=DDL_FILE_PATH

Windows (cmd.exe)

Note: Ensure you have initialized the Google Cloud CLI with authentication and a project by running eithergcloud init; orgcloud auth login andgcloud config set project.
gcloudspannerdatabasesddlupdateDATABASE_ID^--instance=INSTANCE_ID^--ddl-file=DDL_FILE_PATH

What's next

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-17 UTC.