Stored Procedures

A Stored Procedure is a reusable SQL routine stored within a Database Schema. It sits at the same level as a Table in the entity hierarchy.

Entity schema follows the OpenMetadata Standard.

Entity Hierarchy

Stored Procedures belong to a Database Schema:

DatabaseService
└── Database
    └── DatabaseSchema
        ├── Table
        └── StoredProcedure (this page)

The FQN format for a stored procedure is:

service.database.schema.storedProcedure

For example: snowflake_prod.analytics.public.usp_refresh_analytics

Method	Endpoint	Description
`PUT`	`/v1/storedProcedures`	Create or update a stored procedure
`POST`	`/v1/storedProcedures`	Create a stored procedure (POST variant)
`GET`	`/v1/storedProcedures`	List stored procedures
`GET`	`/v1/storedProcedures/{id}`	Get by ID
`GET`	`/v1/storedProcedures/name/{fqn}`	Get by FQN
`PATCH`	`/v1/storedProcedures/{id}`	Update by ID
`PATCH`	`/v1/storedProcedures/name/{fqn}`	Update by name
`DELETE`	`/v1/storedProcedures/{id}`	Delete by ID
`DELETE`	`/v1/storedProcedures/name/{fqn}`	Delete by name
`PUT`	`/v1/storedProcedures/restore`	Restore soft-deleted stored procedure
`GET`	`/v1/storedProcedures/{id}/versions`	List versions
`GET`	`/v1/storedProcedures/{id}/versions/{version}`	Get specific version
`PUT`	`/v1/storedProcedures/{id}/followers`	Add follower
`DELETE`	`/v1/storedProcedures/{id}/followers/{userId}`	Remove follower
`PUT`	`/v1/storedProcedures/{id}/vote`	Add/update vote