Files
fn_registry/functions/infra/docker_volume_remove.md
T
egutierrez 5f4f1f7508 docs: params/output semántico en 506 funciones para composabilidad
Añade campos params y output al frontmatter YAML de las 506 funciones del registry.
Cada parámetro tiene descripción semántica (qué representa, unidades, rango típico)
y cada función describe qué produce su output. Permite a agentes razonar sobre
cadenas de composición (ej: prices → log_return → sharpe_ratio) sin leer código.
2026-04-05 18:45:16 +02:00

43 lines
1.2 KiB
Markdown

---
name: docker_volume_remove
kind: function
lang: go
domain: infra
version: "1.0.0"
purity: impure
signature: "func DockerVolumeRemove(name string, force bool) error"
description: "Elimina un volume Docker por nombre. Si force es true fuerza la eliminación aunque esté en uso."
tags: [docker, volume, remove, delete, infra]
uses_functions: []
uses_types: []
returns: []
returns_optional: false
error_type: "error_go_core"
imports: [fmt, os/exec, strings]
params:
- name: name
desc: "nombre del volume Docker a eliminar"
- name: force
desc: "si true fuerza la eliminacion incluso si esta siendo usado"
output: "nil si se elimino exitosamente, error en caso contrario"
tested: true
tests: ["error si volume no existe", "force flag incluye -f en el comando"]
test_file_path: "functions/infra/docker_volume_remove_test.go"
file_path: "functions/infra/docker_volume_remove.go"
---
## Ejemplo
```go
// Eliminar volume con fuerza
err := DockerVolumeRemove("postgres_data", true)
if err != nil {
log.Fatal(err)
}
fmt.Println("Volume eliminado")
```
## Notas
Ejecuta `docker volume rm [-f] name`. El flag -f solo esta disponible en versiones recientes de Docker. Sin force, falla si el volume esta siendo usado por un contenedor activo.