elixir_google_spreadsheets v0.1.10 GSS.Spreadsheet
Model of Google Spreadsheet for external interaction.
Link to this section Summary
Types
State of currently active Google spreadsheet:
%{
spreadsheet_id => "16Wgt0fuoYDgEAtGtYKF4jdjAhZez0q77UhkKdeKI6B4",
list_name => nil
}
Functions
Append row in a spreadsheet after an index
Returns a specification to start this module under a supervisor
Clear row in a spreadsheet by index
Batched clear, which deletes more then one record. Pass either an array of ranges, or start and end row indexes
Granural read by a custom range from a spreadsheet
Write values in batch based on a ranges schema
Get spreadsheet internal id
Invoked when the server is started. start_link/3
or start/3
will
block until it returns
Get spreadsheet properties
Read row in a spreadsheet by index
Batched read, which returns more than one record. Pass either an array of ranges (or rows), or start and end row indexes
Get total amount of rows in a spreadsheet
Get spreadsheet sheets from properties
Override row in a spreadsheet by index
Batch update to write multiple rows
Link to this section Types
spreadsheet_response :: {:json, map} | {:error, Exception.t} | no_return
State of currently active Google spreadsheet:
%{
spreadsheet_id => "16Wgt0fuoYDgEAtGtYKF4jdjAhZez0q77UhkKdeKI6B4",
list_name => nil
}
Link to this section Functions
append_row(pid, integer, spreadsheet_data, Keyword.t) :: :ok
Append row in a spreadsheet after an index.
Returns a specification to start this module under a supervisor.
See Supervisor
.
clear_row(pid, integer, Keyword.t) :: :ok
Clear row in a spreadsheet by index.
clear_rows(pid, [String.t]) :: :ok | {:error, Exception.t}
Batched clear, which deletes more then one record. Pass either an array of ranges, or start and end row indexes.
clear_rows(pid, integer, integer) :: :ok | {:error, Exception.t}
clear_rows(pid, [String.t], Keyword.t) :: :ok | {:error, Exception.t}
clear_rows(pid, integer, integer, Keyword.t) :: :ok | {:error, Exception.t}
fetch(pid, String.t) :: {:ok, spreadsheet_data} | {:error, Exception.t}
Granural read by a custom range from a spreadsheet.
Write values in batch based on a ranges schema.
Get spreadsheet internal id.
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
args
is the argument term (second argument) passed to start_link/3
.
Returning {:ok, state}
will cause start_link/3
to return
{:ok, pid}
and the process to enter its loop.
Returning {:ok, state, timeout}
is similar to {:ok, state}
except handle_info(:timeout, state)
will be called after timeout
milliseconds if no messages are received within the timeout.
Returning {:ok, state, :hibernate}
is similar to
{:ok, state}
except the process is hibernated before entering the loop. See
c:handle_call/3
for more information on hibernation.
Returning :ignore
will cause start_link/3
to return :ignore
and the
process will exit normally without entering the loop or calling c:terminate/2
.
If used when part of a supervision tree the parent supervisor will not fail
to start nor immediately try to restart the GenServer
. The remainder of the
supervision tree will be (re)started and so the GenServer
should not be
required by other processes. It can be started later with
Supervisor.restart_child/2
as the child specification is saved in the parent
supervisor. The main use cases for this are:
- The
GenServer
is disabled by configuration but might be enabled later. - An error occurred and it will be handled by a different mechanism than the
Supervisor
. Likely this approach involves callingSupervisor.restart_child/2
after a delay to attempt a restart.
Returning {:stop, reason}
will cause start_link/3
to return
{:error, reason}
and the process to exit with reason reason
without
entering the loop or calling c:terminate/2
.
Callback implementation for GenServer.init/1
.
Get spreadsheet properties.
range(integer, integer, integer, integer) :: String.t
read_row(pid, integer, Keyword.t) :: {:ok, spreadsheet_data} | {:error, Exception.t}
Read row in a spreadsheet by index.
read_rows(pid, [String.t] | [integer]) :: {:ok, [spreadsheet_data | nil]} | {:error, Exception.t}
Batched read, which returns more than one record. Pass either an array of ranges (or rows), or start and end row indexes.
By default it returns nils
for an empty rows,
use pad_empty: true
and column_to: integer
options to fill records
with an empty string values.
read_rows(pid, integer, integer) :: {:ok, [spreadsheet_data]} | {:error, atom}
read_rows(pid, [String.t] | [integer], Keyword.t) :: {:ok, [spreadsheet_data]} | {:error, Exception.t}
read_rows(pid, integer, integer, Keyword.t) :: {:ok, [spreadsheet_data]} | {:error, atom}
Get total amount of rows in a spreadsheet.
Get spreadsheet sheets from properties.
write_row(pid, integer, spreadsheet_data, Keyword.t) :: :ok
Override row in a spreadsheet by index.
write_rows(pid, [String.t], [spreadsheet_data]) :: {:ok, any}
Batch update to write multiple rows.
Range schema should define the same amount of rows as amound of records in data and same amount of columns as entries in data record.
write_rows(pid, [String.t], [spreadsheet_data], Keyword.t) :: :ok