graphprotocol / graphprotocol/graph-node

[Feature] Add `graphman unlink`

Open
#4,947 3 comments 0 reactions 1 assignee View on GitHub

@zorancv is already working on this.

Since Dec 1, 2023.

area/graphman enhancement good first issue Stale
Dominant language
Rust
Stars
3.2k
Forks
1.1k
Avg merge
4d 1h
Merged PRs (30d)
1

Description

Description

Add a command that takes an IPFS hash and removes that deployment from all subgraph names that are using it as their current or pending version. In more detail: if a subgraph uses the hash as its current version, set current_version = pending_version and pending_version = null. If it uses it as the pending version, set pending_version = null.

This command should only accept an IPFS hash, not a subgraph name or sgd identifier.

Currently, this is done with the following pl/pgsql proc which also maintains an auditing table info.deleted_subgraphs; it would be good to keep this auditing, too. The code would have to create the table if it does not exist yet.

create or replace function unlink_deployment(did text)
returns void as
$$
declare
  sg record;
begin
  -- We only handle current and pending versions, even though the code
  -- talks about unuded versions for simplicity. We filter unused versions
  -- out in the queries.
  insert into info.deleted_subgraphs(id, name, sid, version,
                                     deployment, namespace, shard,
                                     subgraph_created_at, version_created_at)
  select ds.id,
         s.name,
         s.id as sid,
         case when v.id = s.current_version then 'current'
              when v.id = s.pending_version then 'pending'
              else 'unused' end as version,
         ds.subgraph as deployment,
         ds.name as namespace,
         ds.shard,
         to_timestamp(s.created_at) as subgraph_created_at,
         to_timestamp(v.created_at) as version_created_at
    from subgraphs.subgraph s,
         deployment_schemas ds,
         subgraphs.subgraph_version v
   where v.subgraph = s.id
     and v.id in (s.current_version, s.pending_version)
     and ds.subgraph = v.deployment
     and v.deployment = did;

  for sg in
    select s.id as sid,
           case when v.id = s.current_version then 'current'
              when v.id = s.pending_version then 'pending'
              else 'unused' end as version,
           case when v.id = s.current_version then 1
              when v.id = s.pending_version then 0
              else 2 end as sort_key
      from subgraphs.subgraph s, subgraphs.subgraph_version v,
           deployment_schemas ds
     where s.id = v.subgraph
       and v.id in (s.current_version, s.pending_version)
       and ds.subgraph = v.deployment
       and v.deployment = did
     order by sort_key
  loop
    if sg.version = 'current' then
      update subgraphs.subgraph
         set current_version = pending_version,
             pending_version = null
       where id = sg.sid;
     elsif sg.version = 'pending' then
      update subgraphs.subgraph
         set pending_version = null
       where id = sg.sid;
     end if;
  end loop;
end;
$$ language plpgsql;
Are you aware of any blockers that must be resolved before implementing this feature? If so, which? Link to any relevant GitHub issues.

No response

Some information to help us out
  • Tick this box if you plan on implementing this feature yourself.
  • I have searched the issue tracker to make sure this issue is not a duplicate.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.