Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1# This file is part of daf_butler. 

2# 

3# Developed for the LSST Data Management System. 

4# This product includes software developed by the LSST Project 

5# (http://www.lsst.org). 

6# See the COPYRIGHT file at the top-level directory of this distribution 

7# for details of code ownership. 

8# 

9# This program is free software: you can redistribute it and/or modify 

10# it under the terms of the GNU General Public License as published by 

11# the Free Software Foundation, either version 3 of the License, or 

12# (at your option) any later version. 

13# 

14# This program is distributed in the hope that it will be useful, 

15# but WITHOUT ANY WARRANTY; without even the implied warranty of 

16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

17# GNU General Public License for more details. 

18# 

19# You should have received a copy of the GNU General Public License 

20# along with this program. If not, see <http://www.gnu.org/licenses/>. 

21 

22from .. import Butler 

23 

24 

25def pruneCollection(repo, collection, purge, unstore): 

26 """Remove a collection and possibly prune datasets within it. 

27 

28 Parameters 

29 ---------- 

30 repo : `str` 

31 Same as the ``config`` argument to ``Butler.__init__`` 

32 collection : `str` 

33 Same as the ``name`` argument to ``Butler.pruneCollection``. 

34 purge : `bool`, optional 

35 Same as the ``purge`` argument to ``Butler.pruneCollection``. 

36 unstore: `bool`, optional 

37 Same as the ``unstore`` argument to ``Butler.pruneCollection``. 

38 """ 

39 butler = Butler(repo, writeable=True) 

40 butler.pruneCollection(collection, purge, unstore)