dockercompose

Documentation

Index

• func Down(projectName string) error
• func GetProjectName(psCommandResult string) (string, error)
• func Ps(workspaceFolder string) (string, error)
• func Stop(projectName string) error
• type DownCommandError
  • func (e *DownCommandError) Error() string
• type PsCommandError
  • func (e *PsCommandError) Error() string
• type PsCommandResult
  • func UnmarshalPsCommandResult(data []byte) (PsCommandResult, error)
• type StopCommandError
  • func (e *StopCommandError) Error() string

Functions

func Down

func Down(projectName string) error

`docker compose -p ${projectName} down` を実行する。

func GetProjectName

func GetProjectName(psCommandResult string) (string, error)

func Ps

func Ps(workspaceFolder string) (string, error)

`docker compose ps --format json` を実行し、結果の文字列を返却する。

func Stop

func Stop(projectName string) error

`docker compose -p ${projectName} stop` を実行する。

Types

type DownCommandError

type DownCommandError struct {
	// contains filtered or unexported fields
}

func (*DownCommandError) Error

func (e *DownCommandError) Error() string

type PsCommandError

type PsCommandError struct {
	// contains filtered or unexported fields
}

func (*PsCommandError) Error

func (e *PsCommandError) Error() string

type PsCommandResult

type PsCommandResult struct {
	Project string `json:"Project"`
}

`docker compose ps --format json` コマンドの実行結果スキーマ

Example:

{
  "Command":"\"docker-entrypoint.s…\"",
  "CreatedAt":"2024-04-05 09:29:10 +0900 JST",
  "ExitCode":0,
  "Health":"",
  "ID":"1ab1fd63fb94",
  "Image":"node:18",
  "Labels":"...(snip)",
  "LocalVolumes":"1",
  "Mounts":"/run/desktop/m…,oasiz-mqtt-cli…",
  "Name":"oasiz-mqtt-client-app-1",
  "Names":"oasiz-mqtt-client-app-1",
  "Networks":"oasiz-mqtt-client_default",
  "Ports":"0.0.0.0:5173-\u003e5173/tcp",
  "Project":"oasiz-mqtt-client",
  "Publishers":[
    {
      "URL":"0.0.0.0",
      "TargetPort":5173,
      "PublishedPort":5173,
      "Protocol":"tcp"
    }
  ],
  "RunningFor":"4 seconds ago",
  "Service":"app",
  "Size":"0B",
  "State":"running",
  "Status":"Up 4 seconds"
}

func UnmarshalPsCommandResult

func UnmarshalPsCommandResult(data []byte) (PsCommandResult, error)

type StopCommandError

type StopCommandError struct {
	// contains filtered or unexported fields
}

func (*StopCommandError) Error

func (e *StopCommandError) Error() string