Package io.vertx.mongo.client.gridfs

Interface GridFSBucket

  • public interface GridFSBucket
    Represents a GridFS Bucket
    Since:
    1.3

    • Method Detail

      • getBucketName

        java.lang.String getBucketName()
        The bucket name.
        Returns:
        the bucket name

      • getChunkSizeBytes

        int getChunkSizeBytes()
        Sets the chunk size in bytes. Defaults to 255.
        Returns:
        the chunk size in bytes.

      • withChunkSizeBytes

        GridFSBucket withChunkSizeBytes​(int chunkSizeBytes)
        Create a new GridFSBucket instance with a new chunk size in bytes.
        Parameters:
        chunkSizeBytes - the new chunk size in bytes.
        Returns:
        a new GridFSBucket instance with the different chunk size in bytes

      • withReadPreference

        GridFSBucket withReadPreference​(ReadPreference readPreference)
        Create a new GridFSBucket instance with a different read preference.
        Parameters:
        readPreference - the new ReadPreference for the database
        Returns:
        a new GridFSBucket instance with the different readPreference

      • withWriteConcern

        GridFSBucket withWriteConcern​(WriteConcern writeConcern)
        Create a new GridFSBucket instance with a different write concern.
        Parameters:
        writeConcern - the new WriteConcern for the database
        Returns:
        a new GridFSBucket instance with the different writeConcern

      • withReadConcern

        GridFSBucket withReadConcern​(ReadConcern readConcern)
        Create a new MongoDatabase instance with a different read concern.
        Parameters:
        readConcern - the new ReadConcern for the database
        Returns:
        a new GridFSBucket instance with the different ReadConcern
        Since server release
        3.2
        MongoDB documentation
        Read Concern

      • uploadStream

        Future<ObjectId> uploadStream​(java.lang.String filename,
                              ReadStream<Buffer> source)
        Uploads the contents of the given Publisher to a GridFS bucket.

        Reads the contents of the user file from the source and uploads it as chunks in the chunks collection. After all the chunks have been uploaded, it creates a files collection document for filename in the files collection.

        Parameters:
        filename - the filename
        source - the stream providing the file data
        Returns:
        a future with a single element, the ObjectId of the uploaded file.
        Since:
        1.13

      • uploadStream

        void uploadStream​(java.lang.String filename,
                  ReadStream<Buffer> source,
                  Handler<AsyncResult<ObjectId>> resultHandler)
        Uploads the contents of the given Publisher to a GridFS bucket.

        Reads the contents of the user file from the source and uploads it as chunks in the chunks collection. After all the chunks have been uploaded, it creates a files collection document for filename in the files collection.

        Parameters:
        filename - the filename
        source - the stream providing the file data
        resultHandler - an async result with a single element, the ObjectId of the uploaded file.
        Since:
        1.13

      • uploadFile

        Future<ObjectId> uploadFile​(java.lang.String filename)
        Uploads the contents of the given Publisher to a GridFS bucket.

        Reads the contents of the user file from the source and uploads it as chunks in the chunks collection. After all the chunks have been uploaded, it creates a files collection document for filename in the files collection.

        Parameters:
        filename - the filename providing the file data
        Returns:
        a future with a single element, the ObjectId of the uploaded file.
        Since:
        1.13

      • uploadFile

        void uploadFile​(java.lang.String filename,
                Handler<AsyncResult<ObjectId>> resultHandler)
        Uploads the contents of the given Publisher to a GridFS bucket.

        Reads the contents of the user file from the source and uploads it as chunks in the chunks collection. After all the chunks have been uploaded, it creates a files collection document for filename in the files collection.

        Parameters:
        filename - the filename providing the file data
        resultHandler - an async result with a single element, the ObjectId of the uploaded file.
        Since:
        1.13

      • uploadStream

        Future<ObjectId> uploadStream​(java.lang.String filename,
                              ReadStream<Buffer> source,
                              GridFSUploadOptions options)
        Uploads the contents of the given Publisher to a GridFS bucket.

        Reads the contents of the user file from the source and uploads it as chunks in the chunks collection. After all the chunks have been uploaded, it creates a files collection document for filename in the files collection.

        Parameters:
        filename - the filename
        source - the stream providing the file data
        options - the GridFSUploadOptions
        Returns:
        a future with a single element, the ObjectId of the uploaded file.
        Since:
        1.13

      • uploadStream

        void uploadStream​(java.lang.String filename,
                  ReadStream<Buffer> source,
                  GridFSUploadOptions options,
                  Handler<AsyncResult<ObjectId>> resultHandler)
        Uploads the contents of the given Publisher to a GridFS bucket.

        Reads the contents of the user file from the source and uploads it as chunks in the chunks collection. After all the chunks have been uploaded, it creates a files collection document for filename in the files collection.

        Parameters:
        filename - the filename
        source - the stream providing the file data
        options - the GridFSUploadOptions
        resultHandler - an async result with a single element, the ObjectId of the uploaded file.
        Since:
        1.13

      • uploadFile

        Future<ObjectId> uploadFile​(java.lang.String filename,
                            GridFSUploadOptions options)
        Uploads the contents of the given Publisher to a GridFS bucket.

        Reads the contents of the user file from the source and uploads it as chunks in the chunks collection. After all the chunks have been uploaded, it creates a files collection document for filename in the files collection.

        Parameters:
        filename - the filename providing the file data
        options - the GridFSUploadOptions
        Returns:
        a future with a single element, the ObjectId of the uploaded file.
        Since:
        1.13

      • uploadFile

        void uploadFile​(java.lang.String filename,
                GridFSUploadOptions options,
                Handler<AsyncResult<ObjectId>> resultHandler)
        Uploads the contents of the given Publisher to a GridFS bucket.

        Reads the contents of the user file from the source and uploads it as chunks in the chunks collection. After all the chunks have been uploaded, it creates a files collection document for filename in the files collection.

        Parameters:
        filename - the filename providing the file data
        options - the GridFSUploadOptions
        resultHandler - an async result with a single element, the ObjectId of the uploaded file.
        Since:
        1.13

      • uploadStream

        Future<ObjectId> uploadStream​(ClientSession clientSession,
                              java.lang.String filename,
                              ReadStream<Buffer> source)
        Uploads the contents of the given Publisher to a GridFS bucket.

        Reads the contents of the user file from the source and uploads it as chunks in the chunks collection. After all the chunks have been uploaded, it creates a files collection document for filename in the files collection.

        Parameters:
        clientSession - the client session with which to associate this operation
        filename - the filename
        source - the stream providing the file data
        Returns:
        a future with a single element, the ObjectId of the uploaded file.
        Since:
        1.13
        Since server release
        3.6

      • uploadStream

        void uploadStream​(ClientSession clientSession,
                  java.lang.String filename,
                  ReadStream<Buffer> source,
                  Handler<AsyncResult<ObjectId>> resultHandler)
        Uploads the contents of the given Publisher to a GridFS bucket.

        Reads the contents of the user file from the source and uploads it as chunks in the chunks collection. After all the chunks have been uploaded, it creates a files collection document for filename in the files collection.

        Parameters:
        clientSession - the client session with which to associate this operation
        filename - the filename
        source - the stream providing the file data
        resultHandler - an async result with a single element, the ObjectId of the uploaded file.
        Since:
        1.13
        Since server release
        3.6

      • uploadFile

        Future<ObjectId> uploadFile​(ClientSession clientSession,
                            java.lang.String filename)
        Uploads the contents of the given Publisher to a GridFS bucket.

        Reads the contents of the user file from the source and uploads it as chunks in the chunks collection. After all the chunks have been uploaded, it creates a files collection document for filename in the files collection.

        Parameters:
        clientSession - the client session with which to associate this operation
        filename - the filename providing the file data
        Returns:
        a future with a single element, the ObjectId of the uploaded file.
        Since:
        1.13
        Since server release
        3.6

      • uploadFile

        void uploadFile​(ClientSession clientSession,
                java.lang.String filename,
                Handler<AsyncResult<ObjectId>> resultHandler)
        Uploads the contents of the given Publisher to a GridFS bucket.

        Reads the contents of the user file from the source and uploads it as chunks in the chunks collection. After all the chunks have been uploaded, it creates a files collection document for filename in the files collection.

        Parameters:
        clientSession - the client session with which to associate this operation
        filename - the filename providing the file data
        resultHandler - an async result with a single element, the ObjectId of the uploaded file.
        Since:
        1.13
        Since server release
        3.6

      • uploadStream

        Future<ObjectId> uploadStream​(ClientSession clientSession,
                              java.lang.String filename,
                              ReadStream<Buffer> source,
                              GridFSUploadOptions options)
        Uploads the contents of the given Publisher to a GridFS bucket.

        Reads the contents of the user file from the source and uploads it as chunks in the chunks collection. After all the chunks have been uploaded, it creates a files collection document for filename in the files collection.

        Parameters:
        clientSession - the client session with which to associate this operation
        filename - the filename
        source - the stream providing the file data
        options - the GridFSUploadOptions
        Returns:
        a future with a single element, the ObjectId of the uploaded file.
        Since:
        1.13
        Since server release
        3.6

      • uploadStream

        void uploadStream​(ClientSession clientSession,
                  java.lang.String filename,
                  ReadStream<Buffer> source,
                  GridFSUploadOptions options,
                  Handler<AsyncResult<ObjectId>> resultHandler)
        Uploads the contents of the given Publisher to a GridFS bucket.

        Reads the contents of the user file from the source and uploads it as chunks in the chunks collection. After all the chunks have been uploaded, it creates a files collection document for filename in the files collection.

        Parameters:
        clientSession - the client session with which to associate this operation
        filename - the filename
        source - the stream providing the file data
        options - the GridFSUploadOptions
        resultHandler - an async result with a single element, the ObjectId of the uploaded file.
        Since:
        1.13
        Since server release
        3.6

      • uploadFile

        Future<ObjectId> uploadFile​(ClientSession clientSession,
                            java.lang.String filename,
                            GridFSUploadOptions options)
        Uploads the contents of the given Publisher to a GridFS bucket.

        Reads the contents of the user file from the source and uploads it as chunks in the chunks collection. After all the chunks have been uploaded, it creates a files collection document for filename in the files collection.

        Parameters:
        clientSession - the client session with which to associate this operation
        filename - the filename providing the file data
        options - the GridFSUploadOptions
        Returns:
        a future with a single element, the ObjectId of the uploaded file.
        Since:
        1.13
        Since server release
        3.6

      • uploadFile

        void uploadFile​(ClientSession clientSession,
                java.lang.String filename,
                GridFSUploadOptions options,
                Handler<AsyncResult<ObjectId>> resultHandler)
        Uploads the contents of the given Publisher to a GridFS bucket.

        Reads the contents of the user file from the source and uploads it as chunks in the chunks collection. After all the chunks have been uploaded, it creates a files collection document for filename in the files collection.

        Parameters:
        clientSession - the client session with which to associate this operation
        filename - the filename providing the file data
        options - the GridFSUploadOptions
        resultHandler - an async result with a single element, the ObjectId of the uploaded file.
        Since:
        1.13
        Since server release
        3.6

      • downloadByObjectId

        GridFSDownloadResult downloadByObjectId​(ObjectId id)
        Downloads the contents of the stored file specified by id into the Publisher.
        Parameters:
        id - the ObjectId of the file to be written to the destination Publisher
        Returns:
        a result with a single element, representing the amount of data written
        Since:
        1.13

      • downloadByObjectId

        GridFSDownloadResult downloadByObjectId​(ObjectId id,
                                        GridFSDownloadControlOptions controlOptions)
        Downloads the contents of the stored file specified by id into the Publisher.
        Parameters:
        id - the ObjectId of the file to be written to the destination Publisher
        controlOptions - options
        Returns:
        a result with a single element, representing the amount of data written
        Since:
        1.13

      • downloadByFilename

        GridFSDownloadResult downloadByFilename​(java.lang.String filename)
        Downloads the contents of the stored file specified by filename into the Publisher.
        Parameters:
        filename - the name of the file to be downloaded
        Returns:
        a result with a single element, representing the amount of data written
        Since:
        1.13

      • downloadByFilename

        GridFSDownloadResult downloadByFilename​(java.lang.String filename,
                                        GridFSDownloadControlOptions controlOptions)
        Downloads the contents of the stored file specified by filename into the Publisher.
        Parameters:
        filename - the name of the file to be downloaded
        controlOptions - options
        Returns:
        a result with a single element, representing the amount of data written
        Since:
        1.13

      • downloadByFilename

        GridFSDownloadResult downloadByFilename​(java.lang.String filename,
                                        GridFSDownloadOptions options)
        Downloads the contents of the stored file specified by filename and by the revision in options into the Publisher.
        Parameters:
        filename - the name of the file to be downloaded
        options - the download options
        Returns:
        a result with a single element, representing the amount of data written
        Since:
        1.13

      • downloadByFilename

        GridFSDownloadResult downloadByFilename​(java.lang.String filename,
                                        GridFSDownloadOptions options,
                                        GridFSDownloadControlOptions controlOptions)
        Downloads the contents of the stored file specified by filename and by the revision in options into the Publisher.
        Parameters:
        filename - the name of the file to be downloaded
        options - the download options
        controlOptions - options
        Returns:
        a result with a single element, representing the amount of data written
        Since:
        1.13

      • downloadByObjectId

        GridFSDownloadResult downloadByObjectId​(ClientSession clientSession,
                                        ObjectId id)
        Downloads the contents of the stored file specified by id into the Publisher.
        Parameters:
        clientSession - the client session with which to associate this operation
        id - the ObjectId of the file to be written to the destination Publisher
        Returns:
        a result with a single element, representing the amount of data written
        Since:
        1.13
        Since server release
        3.6

      • downloadByObjectId

        GridFSDownloadResult downloadByObjectId​(ClientSession clientSession,
                                        ObjectId id,
                                        GridFSDownloadControlOptions controlOptions)
        Downloads the contents of the stored file specified by id into the Publisher.
        Parameters:
        clientSession - the client session with which to associate this operation
        id - the ObjectId of the file to be written to the destination Publisher
        controlOptions - options
        Returns:
        a result with a single element, representing the amount of data written
        Since:
        1.13
        Since server release
        3.6

      • downloadByFilename

        GridFSDownloadResult downloadByFilename​(ClientSession clientSession,
                                        java.lang.String filename)
        Downloads the contents of the latest version of the stored file specified by filename into the Publisher.
        Parameters:
        clientSession - the client session with which to associate this operation
        filename - the name of the file to be downloaded
        Returns:
        a result with a single element, representing the amount of data written
        Since:
        1.13
        Since server release
        3.6

      • downloadByFilename

        GridFSDownloadResult downloadByFilename​(ClientSession clientSession,
                                        java.lang.String filename,
                                        GridFSDownloadControlOptions controlOptions)
        Downloads the contents of the latest version of the stored file specified by filename into the Publisher.
        Parameters:
        clientSession - the client session with which to associate this operation
        filename - the name of the file to be downloaded
        controlOptions - options
        Returns:
        a result with a single element, representing the amount of data written
        Since:
        1.13
        Since server release
        3.6

      • downloadByFilename

        GridFSDownloadResult downloadByFilename​(ClientSession clientSession,
                                        java.lang.String filename,
                                        GridFSDownloadOptions options)
        Downloads the contents of the stored file specified by filename and by the revision in options into the Publisher.
        Parameters:
        clientSession - the client session with which to associate this operation
        filename - the name of the file to be downloaded
        options - the download options
        Returns:
        a result with a single element, representing the amount of data written
        Since:
        1.13
        Since server release
        3.6

      • downloadByFilename

        GridFSDownloadResult downloadByFilename​(ClientSession clientSession,
                                        java.lang.String filename,
                                        GridFSDownloadOptions options,
                                        GridFSDownloadControlOptions controlOptions)
        Downloads the contents of the stored file specified by filename and by the revision in options into the Publisher.
        Parameters:
        clientSession - the client session with which to associate this operation
        filename - the name of the file to be downloaded
        options - the download options
        controlOptions - options
        Returns:
        a result with a single element, representing the amount of data written
        Since:
        1.13
        Since server release
        3.6

      • find

        MongoResult<GridFSFile> find()
        Finds all documents in the files collection.
        Returns:
        the GridFS find result interface
        MongoDB documentation
        Find

      • find

        MongoResult<GridFSFile> find​(GridFSFindOptions options)
        Finds all documents in the files collection.
        Parameters:
        options - options
        Returns:
        the GridFS find result interface
        MongoDB documentation
        Find

      • find

        MongoResult<GridFSFile> find​(JsonObject filter)
        Finds all documents in the collection that match the filter.

        Below is an example of filtering against the filename and some nested metadata that can also be stored along with the file data: 

           
       Filters.and(Filters.eq("filename", "mongodb.png"), Filters.eq("metadata.contentType", "image/png"));
        Parameters:
        filter - the query filter
        Returns:
        the GridFS find result interface
        See Also:
        Filters

      • find

        MongoResult<GridFSFile> find​(JsonObject filter,
                             GridFSFindOptions options)
        Finds all documents in the collection that match the filter.

        Below is an example of filtering against the filename and some nested metadata that can also be stored along with the file data: 

           
       Filters.and(Filters.eq("filename", "mongodb.png"), Filters.eq("metadata.contentType", "image/png"));
        Parameters:
        filter - the query filter
        options - options
        Returns:
        the GridFS find result interface
        See Also:
        Filters

      • find

        MongoResult<GridFSFile> find​(ClientSession clientSession)
        Finds all documents in the files collection.
        Parameters:
        clientSession - the client session with which to associate this operation
        Returns:
        the GridFS find result interface
        Since:
        1.7
        Since server release
        3.6
        MongoDB documentation
        Find

      • find

        MongoResult<GridFSFile> find​(ClientSession clientSession,
                             GridFSFindOptions options)
        Finds all documents in the files collection.
        Parameters:
        clientSession - the client session with which to associate this operation
        options - options
        Returns:
        the GridFS find result interface
        Since:
        1.7
        Since server release
        3.6
        MongoDB documentation
        Find

      • find

        MongoResult<GridFSFile> find​(ClientSession clientSession,
                             JsonObject filter)
        Finds all documents in the collection that match the filter.

        Below is an example of filtering against the filename and some nested metadata that can also be stored along with the file data: 

           
       Filters.and(Filters.eq("filename", "mongodb.png"), Filters.eq("metadata.contentType", "image/png"));
        Parameters:
        clientSession - the client session with which to associate this operation
        filter - the query filter
        Returns:
        the GridFS find result interface
        Since:
        1.7
        See Also:
        Filters
        Since server release
        3.6

      • find

        MongoResult<GridFSFile> find​(ClientSession clientSession,
                             JsonObject filter,
                             GridFSFindOptions options)
        Finds all documents in the collection that match the filter.

        Below is an example of filtering against the filename and some nested metadata that can also be stored along with the file data: 

           
       Filters.and(Filters.eq("filename", "mongodb.png"), Filters.eq("metadata.contentType", "image/png"));
        Parameters:
        clientSession - the client session with which to associate this operation
        filter - the query filter
        options - options
        Returns:
        the GridFS find result interface
        Since:
        1.7
        See Also:
        Filters
        Since server release
        3.6

      • delete

        Future<java.lang.Void> delete​(ObjectId id)
        Given a id, delete this stored file's files collection document and associated chunks from a GridFS bucket.
        Parameters:
        id - the ObjectId of the file to be deleted
        Returns:
        a future with a single element, representing that the file has been deleted

      • delete

        void delete​(ObjectId id,
            Handler<AsyncResult<java.lang.Void>> resultHandler)
        Given a id, delete this stored file's files collection document and associated chunks from a GridFS bucket.
        Parameters:
        id - the ObjectId of the file to be deleted
        resultHandler - an async result with a single element, representing that the file has been deleted

      • delete

        Future<java.lang.Void> delete​(java.lang.Object id)
        Given a id, delete this stored file's files collection document and associated chunks from a GridFS bucket.
        Parameters:
        id - the ObjectId of the file to be deleted
        Returns:
        a future with a single element, representing that the file has been deleted

      • delete

        void delete​(java.lang.Object id,
            Handler<AsyncResult<java.lang.Void>> resultHandler)
        Given a id, delete this stored file's files collection document and associated chunks from a GridFS bucket.
        Parameters:
        id - the ObjectId of the file to be deleted
        resultHandler - an async result with a single element, representing that the file has been deleted

      • delete

        Future<java.lang.Void> delete​(ClientSession clientSession,
                              ObjectId id)
        Given a id, delete this stored file's files collection document and associated chunks from a GridFS bucket.
        Parameters:
        clientSession - the client session with which to associate this operation
        id - the ObjectId of the file to be deleted
        Returns:
        a future with a single element, representing that the file has been deleted
        Since:
        1.7
        Since server release
        3.6

      • delete

        void delete​(ClientSession clientSession,
            ObjectId id,
            Handler<AsyncResult<java.lang.Void>> resultHandler)
        Given a id, delete this stored file's files collection document and associated chunks from a GridFS bucket.
        Parameters:
        clientSession - the client session with which to associate this operation
        id - the ObjectId of the file to be deleted
        resultHandler - an async result with a single element, representing that the file has been deleted
        Since:
        1.7
        Since server release
        3.6

      • delete

        Future<java.lang.Void> delete​(ClientSession clientSession,
                              java.lang.Object id)
        Given a id, delete this stored file's files collection document and associated chunks from a GridFS bucket.
        Parameters:
        clientSession - the client session with which to associate this operation
        id - the ObjectId of the file to be deleted
        Returns:
        a future with a single element, representing that the file has been deleted
        Since:
        1.7
        Since server release
        3.6

      • delete

        void delete​(ClientSession clientSession,
            java.lang.Object id,
            Handler<AsyncResult<java.lang.Void>> resultHandler)
        Given a id, delete this stored file's files collection document and associated chunks from a GridFS bucket.
        Parameters:
        clientSession - the client session with which to associate this operation
        id - the ObjectId of the file to be deleted
        resultHandler - an async result with a single element, representing that the file has been deleted
        Since:
        1.7
        Since server release
        3.6

      • rename

        Future<java.lang.Void> rename​(ObjectId id,
                              java.lang.String newFilename)
        Renames the stored file with the specified id.
        Parameters:
        id - the id of the file in the files collection to rename
        newFilename - the new filename for the file
        Returns:
        a future with a single element, representing that the file has been renamed

      • rename

        void rename​(ObjectId id,
            java.lang.String newFilename,
            Handler<AsyncResult<java.lang.Void>> resultHandler)
        Renames the stored file with the specified id.
        Parameters:
        id - the id of the file in the files collection to rename
        newFilename - the new filename for the file
        resultHandler - an async result with a single element, representing that the file has been renamed

      • rename

        Future<java.lang.Void> rename​(java.lang.Object id,
                              java.lang.String newFilename)
        Renames the stored file with the specified id.
        Parameters:
        id - the id of the file in the files collection to rename
        newFilename - the new filename for the file
        Returns:
        a future with a single element, representing that the file has been renamed

      • rename

        void rename​(java.lang.Object id,
            java.lang.String newFilename,
            Handler<AsyncResult<java.lang.Void>> resultHandler)
        Renames the stored file with the specified id.
        Parameters:
        id - the id of the file in the files collection to rename
        newFilename - the new filename for the file
        resultHandler - an async result with a single element, representing that the file has been renamed

      • rename

        Future<java.lang.Void> rename​(ClientSession clientSession,
                              ObjectId id,
                              java.lang.String newFilename)
        Renames the stored file with the specified id.
        Parameters:
        clientSession - the client session with which to associate this operation
        id - the id of the file in the files collection to rename
        newFilename - the new filename for the file
        Returns:
        a future with a single element, representing that the file has been renamed
        Since:
        1.7
        Since server release
        3.6

      • rename

        void rename​(ClientSession clientSession,
            ObjectId id,
            java.lang.String newFilename,
            Handler<AsyncResult<java.lang.Void>> resultHandler)
        Renames the stored file with the specified id.
        Parameters:
        clientSession - the client session with which to associate this operation
        id - the id of the file in the files collection to rename
        newFilename - the new filename for the file
        resultHandler - an async result with a single element, representing that the file has been renamed
        Since:
        1.7
        Since server release
        3.6

      • rename

        Future<java.lang.Void> rename​(ClientSession clientSession,
                              java.lang.Object id,
                              java.lang.String newFilename)
        Renames the stored file with the specified id.
        Parameters:
        clientSession - the client session with which to associate this operation
        id - the id of the file in the files collection to rename
        newFilename - the new filename for the file
        Returns:
        a future with a single element, representing that the file has been renamed
        Since:
        1.7
        Since server release
        3.6

      • rename

        void rename​(ClientSession clientSession,
            java.lang.Object id,
            java.lang.String newFilename,
            Handler<AsyncResult<java.lang.Void>> resultHandler)
        Renames the stored file with the specified id.
        Parameters:
        clientSession - the client session with which to associate this operation
        id - the id of the file in the files collection to rename
        newFilename - the new filename for the file
        resultHandler - an async result with a single element, representing that the file has been renamed
        Since:
        1.7
        Since server release
        3.6

      • drop

        Future<java.lang.Void> drop()
        Drops the data associated with this bucket from the database.
        Returns:
        a future with a single element, representing that the collections have been dropped

      • drop

        void drop​(Handler<AsyncResult<java.lang.Void>> resultHandler)
        Drops the data associated with this bucket from the database.
        Parameters:
        resultHandler - an async result with a single element, representing that the collections have been dropped

      • drop

        Future<java.lang.Void> drop​(ClientSession clientSession)
        Drops the data associated with this bucket from the database.
        Parameters:
        clientSession - the client session with which to associate this operation
        Returns:
        a future with a single element, representing that the collections have been dropped
        Since:
        1.7
        Since server release
        3.6

      • drop

        void drop​(ClientSession clientSession,
          Handler<AsyncResult<java.lang.Void>> resultHandler)
        Drops the data associated with this bucket from the database.
        Parameters:
        clientSession - the client session with which to associate this operation
        resultHandler - an async result with a single element, representing that the collections have been dropped
        Since:
        1.7
        Since server release
        3.6